Package org.opensearch.client.opensearch.core

Class ExistsSourceRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ExistsSourceRequest.Builder>

org.opensearch.client.opensearch.core.ExistsSourceRequest.Builder

All Implemented Interfaces:

CopyableBuilder<ExistsSourceRequest.Builder,ExistsSourceRequest>, MutableBuilder<ExistsSourceRequest.Builder,ExistsSourceRequest>, ObjectBuilder<ExistsSourceRequest>

Enclosing class:

ExistsSourceRequest

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

Builder for ExistsSourceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExistsSourceRequest	build()	Builds a ExistsSourceRequest.
ExistsSourceRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExistsSourceRequest.Builder	id(String value)	Required - Identifier of the document.
final ExistsSourceRequest.Builder	index(String value)	Required - A comma-separated list of data streams, indexes, and aliases.
final ExistsSourceRequest.Builder	preference(String value)	Specifies 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(Refresh value)	If true, OpenSearch refreshes all shards involved in the delete by query after the request completes.
final ExistsSourceRequest.Builder	routing(String value, String... values)	Target the specified primary shard.
final ExistsSourceRequest.Builder	routing(List<String> list)	Target the specified primary shard.
protected ExistsSourceRequest.Builder	self()
final ExistsSourceRequest.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 ExistsSourceRequest.Builder	source(SourceConfigParam value)	true or false to return the _source field or not, or a list of 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)	Explicit version number for concurrency control.
final ExistsSourceRequest.Builder	versionType(VersionType value)	The specific version type: external, external_gte.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ExistsSourceRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ExistsSourceRequest.Builder,ExistsSourceRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ExistsSourceRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExistsSourceRequest.Builder>

id

@Nonnull
public final ExistsSourceRequest.Builder id(String value)

Required - Identifier of the document.

API name: id

index

@Nonnull
public final ExistsSourceRequest.Builder index(String value)

Required - A comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).

API name: index

preference

@Nonnull
public final ExistsSourceRequest.Builder preference(@Nullable
 String value)

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

API name: preference

realtime

@Nonnull
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

@Nonnull
public final ExistsSourceRequest.Builder refresh(@Nullable
 Refresh value)

If true, OpenSearch refreshes all shards involved in the delete by query after the request completes.

API name: refresh

routing

@Nonnull
public final ExistsSourceRequest.Builder routing(List<String> list)

Target the specified primary shard.

API name: routing

Adds all elements of list to routing.

routing

@Nonnull
public final ExistsSourceRequest.Builder routing(String value,
 String... values)

Target the specified primary shard.

API name: routing

Adds one or more values to routing.

source

@Nonnull
public final ExistsSourceRequest.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

@Nonnull
public final ExistsSourceRequest.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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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.

version

@Nonnull
public final ExistsSourceRequest.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

@Nonnull
public final ExistsSourceRequest.Builder versionType(@Nullable
 VersionType value)

The specific version type: external, external_gte.

API name: version_type

build

@Nonnull
public ExistsSourceRequest build()

Builds a ExistsSourceRequest.

Specified by:

build in interface ObjectBuilder<ExistsSourceRequest>

Throws:

NullPointerException - if some of the required fields are null.