[Docs] Java high-level REST client : clean up (#28703)

Make doc titles consistent with the ES docs and wrapping 
the code snippets for better readability.
This commit is contained in:
olcbean 2018-02-20 18:37:53 +01:00 committed by Christoph Büscher
parent 5cbafa4eba
commit 50d8a25d67
2 changed files with 30 additions and 13 deletions

View File

@ -752,17 +752,31 @@ public class IndicesClientDocumentationIT extends ESRestHighLevelClientTestCase
{
// tag::update-aliases-request
IndicesAliasesRequest request = new IndicesAliasesRequest(); // <1>
AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("alias1"); // <2>
AliasActions aliasAction =
new AliasActions(AliasActions.Type.ADD)
.index("index1")
.alias("alias1"); // <2>
request.addAliasAction(aliasAction); // <3>
// end::update-aliases-request
// tag::update-aliases-request2
AliasActions addIndexAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("alias1")
.filter("{\"term\":{\"year\":2016}}"); // <1>
AliasActions addIndicesAction = new AliasActions(AliasActions.Type.ADD).indices("index1", "index2").alias("alias2")
.routing("1"); // <2>
AliasActions removeAction = new AliasActions(AliasActions.Type.REMOVE).index("index3").alias("alias3"); // <3>
AliasActions removeIndexAction = new AliasActions(AliasActions.Type.REMOVE_INDEX).index("index4"); // <4>
AliasActions addIndexAction =
new AliasActions(AliasActions.Type.ADD)
.index("index1")
.alias("alias1")
.filter("{\"term\":{\"year\":2016}}"); // <1>
AliasActions addIndicesAction =
new AliasActions(AliasActions.Type.ADD)
.indices("index1", "index2")
.alias("alias2")
.routing("1"); // <2>
AliasActions removeAction =
new AliasActions(AliasActions.Type.REMOVE)
.index("index3")
.alias("alias3"); // <3>
AliasActions removeIndexAction =
new AliasActions(AliasActions.Type.REMOVE_INDEX)
.index("index4"); // <4>
// end::update-aliases-request2
// tag::update-aliases-request-timeout
@ -775,7 +789,8 @@ public class IndicesClientDocumentationIT extends ESRestHighLevelClientTestCase
// end::update-aliases-request-masterTimeout
// tag::update-aliases-execute
IndicesAliasesResponse indicesAliasesResponse = client.indices().updateAliases(request);
IndicesAliasesResponse indicesAliasesResponse =
client.indices().updateAliases(request);
// end::update-aliases-execute
// tag::update-aliases-response
@ -783,13 +798,15 @@ public class IndicesClientDocumentationIT extends ESRestHighLevelClientTestCase
// end::update-aliases-response
assertTrue(acknowledged);
}
{
IndicesAliasesRequest request = new IndicesAliasesRequest(); // <1>
AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("async"); // <2>
IndicesAliasesRequest request = new IndicesAliasesRequest();
AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("async");
request.addAliasAction(aliasAction);
// tag::update-aliases-execute-listener
ActionListener<IndicesAliasesResponse> listener = new ActionListener<IndicesAliasesResponse>() {
ActionListener<IndicesAliasesResponse> listener =
new ActionListener<IndicesAliasesResponse>() {
@Override
public void onResponse(IndicesAliasesResponse indicesAliasesResponse) {
// <1>

View File

@ -1,10 +1,10 @@
[[java-rest-high-update-aliases]]
=== Update Aliases API
=== Index Aliases API
[[java-rest-high-update-aliases-request]]
==== Indices Aliases Request
The Update Aliases API allows aliasing an index with a name, with all APIs
The Index Aliases API allows aliasing an index with a name, with all APIs
automatically converting the alias name to the actual index name.
An `IndicesAliasesRequest` must have at least one `AliasActions`: