Package co.elastic.clients.elasticsearch.core

Class GetRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetRequest.Builder>
co.elastic.clients.elasticsearch.core.GetRequest.Builder
All Implemented Interfaces:
WithJson<GetRequest.Builder>, ObjectBuilder<GetRequest>
Enclosing class:
GetRequest
public static class GetRequest.Builder extends RequestBase.AbstractBuilder<GetRequest.Builder> implements ObjectBuilder<GetRequest>
Builder for GetRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • source

      public final GetRequest.Builder source(@Nullable SourceConfigParam value)
      Indicates whether to return the _source field (true or false) or lists the fields to return.

      API name: _source

    • source

      public final GetRequest.Builder source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)
      Indicates whether to return the _source field (true or false) or lists the fields to return.

      API name: _source

    • sourceExcludes

      public final GetRequest.Builder sourceExcludes(List<String> list)
      A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_excludes

      Adds all elements of list to sourceExcludes.

    • sourceExcludes

      public final GetRequest.Builder sourceExcludes(String value, String... values)
      A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_excludes

      Adds one or more values to sourceExcludes.

    • sourceIncludes

      public final GetRequest.Builder sourceIncludes(List<String> list)
      A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_includes

      Adds all elements of list to sourceIncludes.

    • sourceIncludes

      public final GetRequest.Builder sourceIncludes(String value, String... values)
      A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_includes

      Adds one or more values to sourceIncludes.

    • forceSyntheticSource

      public final GetRequest.Builder forceSyntheticSource(@Nullable Boolean value)
      Indicates whether the request forces synthetic _source. Use this paramater to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index.

      API name: force_synthetic_source

    • id

      public final GetRequest.Builder id(String value)
      Required - A unique document identifier.

      API name: id

    • index

      public final GetRequest.Builder index(String value)
      Required - The name of the index that contains the document.

      API name: index

    • preference

      public final GetRequest.Builder preference(@Nullable String value)
      The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.

      If it is set to _local, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.

      API name: preference

    • realtime

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

      API name: realtime

    • refresh

      public final GetRequest.Builder refresh(@Nullable Boolean value)
      If true, the request refreshes the relevant shards before retrieving the document. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).

      API name: refresh

    • routing

      public final GetRequest.Builder routing(@Nullable String value)
      A custom value used to route operations to a specific shard.

      API name: routing

    • storedFields

      public final GetRequest.Builder storedFields(List<String> list)
      A comma-separated 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. Only leaf fields can be retrieved with the stored_field option. Object fields can't be returned;​if specified, the request fails.

      API name: stored_fields

      Adds all elements of list to storedFields.

    • storedFields

      public final GetRequest.Builder storedFields(String value, String... values)
      A comma-separated 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. Only leaf fields can be retrieved with the stored_field option. Object fields can't be returned;​if specified, the request fails.

      API name: stored_fields

      Adds one or more values to storedFields.

    • version

      public final GetRequest.Builder version(@Nullable Long value)
      The version number for concurrency control. It must match the current version of the document for the request to succeed.

      API name: version

    • versionType

      public final GetRequest.Builder versionType(@Nullable VersionType value)
      The version type.

      API name: version_type

    • self

      protected GetRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetRequest.Builder>

    • build

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