Package co.elastic.clients.elasticsearch.core

Class ExistsSourceRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.core.ExistsSourceRequest.Builder

All Implemented Interfaces:

WithJson<ExistsSourceRequest.Builder>, ObjectBuilder<ExistsSourceRequest>

Enclosing class:

ExistsSourceRequest

public static class ExistsSourceRequest.Builder
extends RequestBase.AbstractBuilder<ExistsSourceRequest.Builder>
implements ObjectBuilder<ExistsSourceRequest>

Builder for ExistsSourceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExistsSourceRequest	build()	Builds a ExistsSourceRequest.
final ExistsSourceRequest.Builder	id(String value)	Required - A unique identifier for the document.
final ExistsSourceRequest.Builder	index(String value)	Required - A comma-separated list of data streams, indices, and aliases.
final ExistsSourceRequest.Builder	preference(String value)	The node or shard the operation should be performed on.
final ExistsSourceRequest.Builder	realtime(Boolean value)	If true, the request is real-time as opposed to near-real-time.
final ExistsSourceRequest.Builder	refresh(Boolean value)	If true, the request refreshes the relevant shards before retrieving the document.
final ExistsSourceRequest.Builder	routing(String value)	A custom value used to route operations to a specific shard.
protected ExistsSourceRequest.Builder	self()
final ExistsSourceRequest.Builder	source(SourceConfigParam value)	Indicates whether to return the _source field (true or false) or lists the fields to return.
final ExistsSourceRequest.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 ExistsSourceRequest.Builder	sourceExcludes(String value, String... values)	A comma-separated list of source fields to exclude in the response.
final ExistsSourceRequest.Builder	sourceExcludes(List<String> list)	A comma-separated list of source fields to exclude in the response.
final ExistsSourceRequest.Builder	sourceIncludes(String value, String... values)	A comma-separated list of source fields to include in the response.
final ExistsSourceRequest.Builder	sourceIncludes(List<String> list)	A comma-separated list of source fields to include in the response.
final ExistsSourceRequest.Builder	version(Long value)	The version number for concurrency control.
final ExistsSourceRequest.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 ExistsSourceRequest.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 ExistsSourceRequest.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 ExistsSourceRequest.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 ExistsSourceRequest.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 ExistsSourceRequest.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 ExistsSourceRequest.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 ExistsSourceRequest.Builder id(String value)

Required - A unique identifier for the document.

API name: id

index

public final ExistsSourceRequest.Builder index(String value)

Required - A comma-separated list of data streams, indices, and aliases. It supports wildcards (*).

API name: index

preference

public final ExistsSourceRequest.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 ExistsSourceRequest.Builder realtime(@Nullable
 Boolean value)

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

API name: realtime

refresh

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

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

API name: routing

version

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

The version type.

API name: version_type

self

protected ExistsSourceRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExistsSourceRequest.Builder>

build

public ExistsSourceRequest build()

Builds a ExistsSourceRequest.

Specified by:

build in interface ObjectBuilder<ExistsSourceRequest>

Throws:

NullPointerException - if some of the required fields are null.