Package org.opensearch.client.opensearch._global

Class GetRequest.AbstractBuilder<BuilderT extends GetRequest.AbstractBuilder<BuilderT>>

java.lang.Object
org.opensearch.client.opensearch._global.GetRequest.AbstractBuilder<BuilderT>
Direct Known Subclasses:
GetRequest.Builder, GetSourceRequest.Builder
Enclosing class:
GetRequest
protected abstract static class GetRequest.AbstractBuilder<BuilderT extends GetRequest.AbstractBuilder<BuilderT>>
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected AbstractBuilder()  

  • Method Summary

    Modifier and Type Method Description
    BuilderT addSourceExcludes​(java.lang.String value)
    Add a value to sourceExcludes(List), creating the list if needed.
    BuilderT addSourceIncludes​(java.lang.String value)
    Add a value to sourceIncludes(List), creating the list if needed.
    BuilderT addStoredFields​(java.lang.String value)
    Add a value to storedFields(List), creating the list if needed.
    BuilderT id​(java.lang.String value)
    Unique identifier of the document.
    BuilderT index​(java.lang.String value)
    Name of the index that contains the document.
    BuilderT preference​(java.lang.String value)
    Specifies the node or shard the operation should be performed on.
    BuilderT realtime​(java.lang.Boolean value)
    Boolean) If true, the request is real-time as opposed to near-real-time.
    BuilderT refresh​(java.lang.Boolean value)
    If true, Elasticsearch refreshes the affected shards to make this operation visible to search.
    BuilderT routing​(jakarta.json.JsonValue value)
    Target the specified primary shard.
    protected abstract BuilderT self()  
    BuilderT source​(jakarta.json.JsonValue value)
    True or false to return the _source field or not, or a list of fields to return.
    BuilderT sourceEnabled​(java.lang.Boolean value)
    API name: source_enabled
    BuilderT sourceExcludes​(java.lang.String... value)
    A comma-separated list of source fields to exclude in the response.
    BuilderT sourceExcludes​(java.util.List<java.lang.String> value)
    A comma-separated list of source fields to exclude in the response.
    BuilderT sourceIncludes​(java.lang.String... value)
    A comma-separated list of source fields to include in the response.
    BuilderT sourceIncludes​(java.util.List<java.lang.String> value)
    A comma-separated list of source fields to include in the response.
    BuilderT storedFields​(java.lang.String... value)
    API name: stored_fields
    BuilderT storedFields​(java.util.List<java.lang.String> value)
    API name: stored_fields
    BuilderT type​(java.lang.String value)
    API name: type
    BuilderT version​(java.lang.Number value)
    Explicit version number for concurrency control.
    BuilderT versionType​(jakarta.json.JsonValue value)
    Specific version type: internal, external, external_gte.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • id

      public BuilderT id​(java.lang.String value)
      Unique identifier of the document. API name: id

    • index

      public BuilderT index​(java.lang.String value)
      Name of the index that contains the document. API name: index

    • type

      public BuilderT type​(@Nullable java.lang.String value)
      API name: type

    • preference

      public BuilderT preference​(@Nullable java.lang.String value)
      Specifies the node or shard the operation should be performed on. Random by default. API name: preference

    • realtime

      public BuilderT realtime​(@Nullable java.lang.Boolean value)
      Boolean) If true, the request is real-time as opposed to near-real-time. API name: realtime

    • refresh

      public BuilderT refresh​(@Nullable java.lang.Boolean value)
      If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. API name: refresh

    • routing

      public BuilderT routing​(@Nullable jakarta.json.JsonValue value)
      Target the specified primary shard. API name: routing

    • sourceEnabled

      public BuilderT sourceEnabled​(@Nullable java.lang.Boolean value)
      API name: source_enabled

    • sourceExcludes

      public BuilderT sourceExcludes​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of source fields to exclude in the response. API name: _source_excludes

    • sourceExcludes

      public BuilderT sourceExcludes​(java.lang.String... value)
      A comma-separated list of source fields to exclude in the response. API name: _source_excludes

    • addSourceExcludes

      public BuilderT addSourceExcludes​(java.lang.String value)
      Add a value to sourceExcludes(List), creating the list if needed.

    • sourceIncludes

      public BuilderT sourceIncludes​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of source fields to include in the response. API name: _source_includes

    • sourceIncludes

      public BuilderT sourceIncludes​(java.lang.String... value)
      A comma-separated list of source fields to include in the response. API name: _source_includes

    • addSourceIncludes

      public BuilderT addSourceIncludes​(java.lang.String value)
      Add a value to sourceIncludes(List), creating the list if needed.

    • storedFields

      public BuilderT storedFields​(@Nullable java.util.List<java.lang.String> value)
      API name: stored_fields

    • storedFields

      public BuilderT storedFields​(java.lang.String... value)
      API name: stored_fields

    • addStoredFields

      public BuilderT addStoredFields​(java.lang.String value)
      Add a value to storedFields(List), creating the list if needed.

    • version

      public BuilderT version​(@Nullable java.lang.Number value)
      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

      public BuilderT versionType​(@Nullable jakarta.json.JsonValue value)
      Specific version type: internal, external, external_gte. API name: version_type

    • source

      public BuilderT source​(@Nullable jakarta.json.JsonValue value)
      True or false to return the _source field or not, or a list of fields to return. API name: _source

    • self

      protected abstract BuilderT self()