Class GetAliasRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.GetAliasRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetAliasRequest>
Enclosing class:
GetAliasRequest

public static class GetAliasRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetAliasRequest>
Builder for GetAliasRequest.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • name

      public GetAliasRequest.Builder name​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of alias names to return

      API name: name

    • name

      public GetAliasRequest.Builder name​(java.lang.String... value)
      A comma-separated list of alias names to return

      API name: name

    • addName

      public GetAliasRequest.Builder addName​(java.lang.String value)
      Add a value to name(List), creating the list if needed.
    • index

      public GetAliasRequest.Builder index​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of index names to filter aliases

      API name: index

    • index

      public GetAliasRequest.Builder index​(java.lang.String... value)
      A comma-separated list of index names to filter aliases

      API name: index

    • addIndex

      public GetAliasRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.
    • allowNoIndices

      public GetAliasRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • expandWildcards

      public GetAliasRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

      public GetAliasRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

      public GetAliasRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.
    • ignoreUnavailable

      public GetAliasRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • local

      public GetAliasRequest.Builder local​(@Nullable java.lang.Boolean value)
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • build

      public GetAliasRequest build()
      Builds a GetAliasRequest.
      Specified by:
      build in interface ObjectBuilder<GetAliasRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.