Package org.opensearch.client.opensearch.indices

Class GetRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.GetRequest
public final class GetRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  GetRequest.Builder
    Builder for GetRequest.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Endpoint<GetRequest,​GetResponse,​OpenSearchError> ENDPOINT
    Endpoint "indices.get".

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected GetRequest​(GetRequest.Builder builder)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean allowNoIndices()
    API name: allow_no_indices
    jakarta.json.JsonValue expandWildcards()
    Type of index that wildcard expressions can match.
    java.lang.Boolean flatSettings()
    If true, returns settings in flat format.
    java.lang.Boolean ignoreUnavailable()
    If false, requests that target a missing index return an error.
    java.lang.Boolean includeDefaults()
    If true, return all default settings in the response.
    java.lang.Boolean includeTypeName()
    If true, a mapping type is expected in the body of mappings.
    java.util.List<java.lang.String> index()
    Comma-separated list of data streams, indices, and index aliases used to limit the request.
    java.lang.Boolean local()
    If true, the request retrieves information from the local node only.
    jakarta.json.JsonValue masterTimeout()
    Period to wait for a connection to the master node.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • index

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

    • allowNoIndices

      @Nullable public java.lang.Boolean allowNoIndices()
      API name: allow_no_indices

    • expandWildcards

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

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

    • ignoreUnavailable

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

    • includeDefaults

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

    • includeTypeName

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

    • local

      @Nullable public java.lang.Boolean local()
      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

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