honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/indices/get_alias.asciidoc

65 lines
2.3 KiB
Plaintext
Raw Normal View History

Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
--
:api: get-alias
:request: GetAliasesRequest
:response: GetAliasesResponse
--
[id="{upid}-{api}"]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
=== Get Alias API
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
[id="{upid}-{api}-request"]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
==== Get Alias Request
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
The Get Alias API uses +{request}+ as its request object.
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
One or more aliases can be optionally provided either at construction
time or later on through the relevant setter method.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include-tagged::{doc-tests-file}[{api}-request]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
--------------------------------------------------
==== Optional arguments
The following arguments can optionally be provided:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include-tagged::{doc-tests-file}[{api}-request-alias]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
--------------------------------------------------
<1> One or more aliases to retrieve
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include-tagged::{doc-tests-file}[{api}-request-indices]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
--------------------------------------------------
<1> The index or indices that the alias is associated with
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include-tagged::{doc-tests-file}[{api}-request-indicesOptions]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
--------------------------------------------------
<1> Setting `IndicesOptions` controls how unavailable indices are resolved and
how wildcard expressions are expanded when looking for aliases that belong to
specified indices.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include-tagged::{doc-tests-file}[{api}-request-local]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
--------------------------------------------------
<1> The `local` flag (defaults to `false`) controls whether the aliases need
to be looked up in the local cluster state or in the cluster state held by
the elected master node
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include::../execution.asciidoc[]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
[id="{upid}-{api}-response"]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
==== Get Alias Response
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
The returned +{response}+ allows to retrieve information about the
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
executed operation as follows:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
include-tagged::{doc-tests-file}[{api}-response]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
--------------------------------------------------
<1> Retrieves a map of indices and their aliases