Package org.opensearch.client.opensearch.core

Class GetRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.GetRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetRequest>

Enclosing class:

GetRequest

public static class GetRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetRequest>

Builder for GetRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetRequest	build()	Builds a GetRequest.
GetRequest.Builder	id(java.lang.String value)	Required - Unique identifier of the document.
GetRequest.Builder	index(java.lang.String value)	Required - Name of the index that contains the document.
GetRequest.Builder	preference(java.lang.String value)	Specifies the node or shard the operation should be performed on.
GetRequest.Builder	realtime(java.lang.Boolean value)	Boolean) If true, the request is real-time as opposed to near-real-time.
GetRequest.Builder	refresh(java.lang.Boolean value)	If true, Elasticsearch refreshes the affected shards to make this operation visible to search.
GetRequest.Builder	routing(java.lang.String value)	Target the specified primary shard.
GetRequest.Builder	source(java.util.function.Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)	True or false to return the _source field or not, or a list of fields to return.
GetRequest.Builder	source(SourceConfigParam value)	True or false to return the _source field or not, or a list of fields to return.
GetRequest.Builder	sourceExcludes(java.lang.String value, java.lang.String... values)	A comma-separated list of source fields to exclude in the response.
GetRequest.Builder	sourceExcludes(java.util.List<java.lang.String> list)	A comma-separated list of source fields to exclude in the response.
GetRequest.Builder	sourceIncludes(java.lang.String value, java.lang.String... values)	A comma-separated list of source fields to include in the response.
GetRequest.Builder	sourceIncludes(java.util.List<java.lang.String> list)	A comma-separated list of source fields to include in the response.
GetRequest.Builder	storedFields(java.lang.String value, java.lang.String... values)	A comma-separated list of stored fields to return in the response
GetRequest.Builder	storedFields(java.util.List<java.lang.String> list)	A comma-separated list of stored fields to return in the response
GetRequest.Builder	version(java.lang.Long value)	Explicit version number for concurrency control.
GetRequest.Builder	versionType(VersionType value)	Specific version type: internal, external, external_gte.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

source

public final GetRequest.Builder source(@Nullable
                                       SourceConfigParam value)

True or false to return the _source field or not, or a list of fields to return.

API name: _source

source

public final GetRequest.Builder source(java.util.function.Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)

True or false to return the _source field or not, or a list of fields to return.

API name: _source

sourceExcludes

public final GetRequest.Builder sourceExcludes(java.util.List<java.lang.String> list)

A comma-separated list of source fields to exclude in the response.

API name: _source_excludes

Adds all elements of list to sourceExcludes.

sourceExcludes

public final GetRequest.Builder sourceExcludes(java.lang.String value,
                                               java.lang.String... values)

A comma-separated list of source fields to exclude in the response.

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

public final GetRequest.Builder sourceIncludes(java.util.List<java.lang.String> list)

A comma-separated list of source fields to include in the response.

API name: _source_includes

Adds all elements of list to sourceIncludes.

sourceIncludes

public final GetRequest.Builder sourceIncludes(java.lang.String value,
                                               java.lang.String... values)

A comma-separated list of source fields to include in the response.

API name: _source_includes

Adds one or more values to sourceIncludes.

id

public final GetRequest.Builder id(java.lang.String value)

Required - Unique identifier of the document.

API name: id

index

public final GetRequest.Builder index(java.lang.String value)

Required - Name of the index that contains the document.

API name: index

preference

public final GetRequest.Builder 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 final GetRequest.Builder 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 final GetRequest.Builder 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 final GetRequest.Builder routing(@Nullable
                                        java.lang.String value)

Target the specified primary shard.

API name: routing

storedFields

public final GetRequest.Builder storedFields(java.util.List<java.lang.String> list)

A comma-separated list of stored fields to return in the response

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final GetRequest.Builder storedFields(java.lang.String value,
                                             java.lang.String... values)

A comma-separated list of stored fields to return in the response

API name: stored_fields

Adds one or more values to storedFields.

version

public final GetRequest.Builder version(@Nullable
                                        java.lang.Long 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 final GetRequest.Builder versionType(@Nullable
                                            VersionType value)

Specific version type: internal, external, external_gte.

API name: version_type

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.