Package co.elastic.clients.elasticsearch.core

Class GetRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.GetRequest
public class GetRequest extends RequestBase
Returns a document.
See Also:

  • Field Details

  • Method Details

    • of

      public static GetRequest of(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)

    • source

      @Nullable public final SourceConfigParam source()
      True or false to return the _source field or not, or a list of fields to return.

      API name: _source

    • sourceExcludes

      public final List<String> sourceExcludes()
      A comma-separated list of source fields to exclude in the response.

      API name: _source_excludes

    • sourceIncludes

      public final List<String> sourceIncludes()
      A comma-separated list of source fields to include in the response.

      API name: _source_includes

    • forceSyntheticSource

      @Nullable public final Boolean forceSyntheticSource()
      Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

      API name: force_synthetic_source

    • id

      public final String id()
      Required - Unique identifier of the document.

      API name: id

    • index

      public final String index()
      Required - Name of the index that contains the document.

      API name: index

    • preference

      @Nullable public final String preference()
      Specifies the node or shard the operation should be performed on. Random by default.

      API name: preference

    • realtime

      @Nullable public final Boolean realtime()
      If true, the request is real-time as opposed to near-real-time.

      API name: realtime

    • refresh

      @Nullable public final Boolean refresh()
      If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.

      API name: refresh

    • routing

      @Nullable public final String routing()
      Target the specified primary shard.

      API name: routing

    • storedFields

      public final List<String> storedFields()
      List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false.

      API name: stored_fields

    • version

      @Nullable public final Long version()
      Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

      API name: version

    • versionType

      @Nullable public final VersionType versionType()
      Specific version type: internal, external, external_gte.

      API name: version_type

    • createGetEndpoint

      public static <TDocument> Endpoint<GetRequest,GetResponse<TDocument>,ErrorResponse> createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "get" endpoint.