Package org.opensearch.client.opensearch.core

Class GetSourceRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.GetSourceRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetSourceRequest>

Enclosing class:

GetSourceRequest

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

Builder for GetSourceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

source

public final GetSourceRequest.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 GetSourceRequest.Builder source(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 GetSourceRequest.Builder sourceExcludes(List<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 GetSourceRequest.Builder sourceExcludes(String value,
 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 GetSourceRequest.Builder sourceIncludes(List<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 GetSourceRequest.Builder sourceIncludes(String value,
 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 GetSourceRequest.Builder id(String value)

Required - Unique identifier of the document.

API name: id

index

public final GetSourceRequest.Builder index(String value)

Required - Name of the index that contains the document.

API name: index

preference

public final GetSourceRequest.Builder preference(@Nullable
 String value)

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

realtime

public final GetSourceRequest.Builder realtime(@Nullable
 Boolean value)

Boolean) If true, the request is real-time as opposed to near-real-time.

API name: realtime

refresh

public final GetSourceRequest.Builder refresh(@Nullable
 Boolean value)

If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.

API name: refresh

routing

public final GetSourceRequest.Builder routing(@Nullable
 String value)

Target the specified primary shard.

API name: routing

storedFields

public final GetSourceRequest.Builder storedFields(List<String> list)

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final GetSourceRequest.Builder storedFields(String value,
 String... values)

API name: stored_fields

Adds one or more values to storedFields.

version

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

Specific version type: internal, external, external_gte.

API name: version_type

build

public GetSourceRequest build()

Builds a GetSourceRequest.

Specified by:

build in interface ObjectBuilder<GetSourceRequest>

Throws:

NullPointerException - if some of the required fields are null.