Package org.opensearch.client.opensearch.indices

Class GetRequest.Builder

java.lang.Object
org.opensearch.client.opensearch.indices.GetRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetRequest>
Enclosing class:
GetRequest
public static class GetRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetRequest>
Builder for GetRequest.

  • Constructor Details

  • Method Details

    • index

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

    • index

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

    • addIndex

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

    • allowNoIndices

      public GetRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      API name: allow_no_indices

    • expandWildcards

      public GetRequest.Builder expandWildcards​(@Nullable jakarta.json.JsonValue value)
      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

    • flatSettings

      public GetRequest.Builder flatSettings​(@Nullable java.lang.Boolean value)
      If true, returns settings in flat format. API name: flat_settings

    • ignoreUnavailable

      public GetRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If false, requests that target a missing index return an error. API name: ignore_unavailable

    • includeDefaults

      public GetRequest.Builder includeDefaults​(@Nullable java.lang.Boolean value)
      If true, return all default settings in the response. API name: include_defaults

    • includeTypeName

      public GetRequest.Builder includeTypeName​(@Nullable java.lang.Boolean value)
      If true, a mapping type is expected in the body of mappings. API name: include_type_name

    • local

      public GetRequest.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 GetRequest.Builder masterTimeout​(@Nullable jakarta.json.JsonValue 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

    • build

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