Package co.elastic.clients.elasticsearch.indices

Class GetIndexRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.indices.GetIndexRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetIndexRequest>
Enclosing class:
GetIndexRequest
public static class GetIndexRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetIndexRequest>
Builder for GetIndexRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetIndexRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      Ignore if a wildcard expression resolves to no concrete indices (default: false)

      API name: allow_no_indices

    • expandWildcards

      public final GetIndexRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final GetIndexRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • flatSettings

      public final GetIndexRequest.Builder flatSettings​(@Nullable java.lang.Boolean value)
      If true, returns settings in flat format.

      API name: flat_settings

    • ignoreUnavailable

      public final GetIndexRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If false, requests that target a missing index return an error.

      API name: ignore_unavailable

    • includeDefaults

      public final GetIndexRequest.Builder includeDefaults​(@Nullable java.lang.Boolean value)
      If true, return all default settings in the response.

      API name: include_defaults

    • includeTypeName

      public final GetIndexRequest.Builder includeTypeName​(@Nullable java.lang.Boolean value)
      If true, a mapping type is expected in the body of mappings.

      API name: include_type_name

    • index

      public final GetIndexRequest.Builder index​(java.util.List<java.lang.String> list)
      Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

      API name: index

      Adds all elements of list to index.

    • index

      public final GetIndexRequest.Builder index​(java.lang.String value, java.lang.String... values)
      Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

      API name: index

      Adds one or more values to index.

    • local

      public final GetIndexRequest.Builder local​(@Nullable java.lang.Boolean value)
      If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      API name: local

    • masterTimeout

      public final GetIndexRequest.Builder masterTimeout​(@Nullable Time value)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • masterTimeout

      public final GetIndexRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • build

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