Package co.elastic.clients.elasticsearch.core

Class GetSourceRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetSourceRequest.Builder>

co.elastic.clients.elasticsearch.core.GetSourceRequest.Builder

All Implemented Interfaces:

WithJson<GetSourceRequest.Builder>, ObjectBuilder<GetSourceRequest>

Enclosing class:

GetSourceRequest

public static class GetSourceRequest.Builder
extends RequestBase.AbstractBuilder<GetSourceRequest.Builder>
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 - A unique document identifier.
final GetSourceRequest.Builder	index(String value)	Required - The name of the index that contains the document.
final GetSourceRequest.Builder	preference(String value)	The node or shard the operation should be performed on.
final GetSourceRequest.Builder	realtime(Boolean value)	If true, the request is real-time as opposed to near-real-time.
final GetSourceRequest.Builder	refresh(Boolean value)	If true, the request refreshes the relevant shards before retrieving the document.
final GetSourceRequest.Builder	routing(String value)	A custom value used to route operations to a specific shard.
protected GetSourceRequest.Builder	self()
final GetSourceRequest.Builder	source(SourceConfigParam value)	Indicates whether to return the _source field (true or false) or lists the fields to return.
final GetSourceRequest.Builder	source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)	Indicates whether to return the _source field (true or false) or lists the 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)	A comma-separated list of stored fields to return as part of a hit.
final GetSourceRequest.Builder	storedFields(List<String> list)	A comma-separated list of stored fields to return as part of a hit.
final GetSourceRequest.Builder	version(Long value)	The version number for concurrency control.
final GetSourceRequest.Builder	versionType(VersionType value)	The version type.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

source

public final GetSourceRequest.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 GetSourceRequest.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 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 - A unique document identifier.

API name: id

index

public final GetSourceRequest.Builder index(String value)

Required - The name of the index that contains the document.

API name: index

preference

public final GetSourceRequest.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.

API name: preference

realtime

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

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, 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 GetSourceRequest.Builder routing(@Nullable
 String value)

A custom value used to route operations to a specific shard.

API name: routing

storedFields

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

A comma-separated list of stored fields to return as part of a hit.

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

A comma-separated list of stored fields to return as part of a hit.

API name: stored_fields

Adds one or more values to storedFields.

version

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

The version type.

API name: version_type

self

protected GetSourceRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetSourceRequest.Builder>

build

public GetSourceRequest build()

Builds a GetSourceRequest.

Specified by:

build in interface ObjectBuilder<GetSourceRequest>

Throws:

NullPointerException - if some of the required fields are null.