Package org.opensearch.client.opensearch.core

Class ExistsSourceRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<ExistsSourceRequest>

Enclosing class:

ExistsSourceRequest

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

Builder for ExistsSourceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExistsSourceRequest	build()	Builds a ExistsSourceRequest.
ExistsSourceRequest.Builder	id(java.lang.String value)	Required - The document ID
ExistsSourceRequest.Builder	index(java.lang.String value)	Required - The name of the index
ExistsSourceRequest.Builder	preference(java.lang.String value)	Specify the node or shard the operation should be performed on (default: random)
ExistsSourceRequest.Builder	realtime(java.lang.Boolean value)	Specify whether to perform the operation in realtime or search mode
ExistsSourceRequest.Builder	refresh(java.lang.Boolean value)	Refresh the shard containing the document before performing the operation
ExistsSourceRequest.Builder	routing(java.lang.String value)	Specific routing value
ExistsSourceRequest.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
ExistsSourceRequest.Builder	source(SourceConfigParam value)	True or false to return the _source field or not, or a list of fields to return
ExistsSourceRequest.Builder	sourceExcludes(java.lang.String value, java.lang.String... values)	A list of fields to exclude from the returned _source field
ExistsSourceRequest.Builder	sourceExcludes(java.util.List<java.lang.String> list)	A list of fields to exclude from the returned _source field
ExistsSourceRequest.Builder	sourceIncludes(java.lang.String value, java.lang.String... values)	A list of fields to extract and return from the _source field
ExistsSourceRequest.Builder	sourceIncludes(java.util.List<java.lang.String> list)	A list of fields to extract and return from the _source field
ExistsSourceRequest.Builder	version(java.lang.Long value)	Explicit version number for concurrency control
ExistsSourceRequest.Builder	versionType(VersionType value)	Specific version type

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

public final ExistsSourceRequest.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 ExistsSourceRequest.Builder sourceExcludes(java.util.List<java.lang.String> list)

A list of fields to exclude from the returned _source field

API name: _source_excludes

Adds all elements of list to sourceExcludes.

sourceExcludes

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

A list of fields to exclude from the returned _source field

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

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

A list of fields to extract and return from the _source field

API name: _source_includes

Adds all elements of list to sourceIncludes.

sourceIncludes

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

A list of fields to extract and return from the _source field

API name: _source_includes

Adds one or more values to sourceIncludes.

id

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

Required - The document ID

API name: id

index

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

Required - The name of the index

API name: index

preference

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

Specify the node or shard the operation should be performed on (default: random)

API name: preference

realtime

public final ExistsSourceRequest.Builder realtime(@Nullable
                                                  java.lang.Boolean value)

Specify whether to perform the operation in realtime or search mode

API name: realtime

refresh

public final ExistsSourceRequest.Builder refresh(@Nullable
                                                 java.lang.Boolean value)

Refresh the shard containing the document before performing the operation

API name: refresh

routing

public final ExistsSourceRequest.Builder routing(@Nullable
                                                 java.lang.String value)

Specific routing value

API name: routing

version

public final ExistsSourceRequest.Builder version(@Nullable
                                                 java.lang.Long value)

Explicit version number for concurrency control

API name: version

versionType

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

Specific version type

API name: version_type

build

public ExistsSourceRequest build()

Builds a ExistsSourceRequest.

Specified by:

build in interface ObjectBuilder<ExistsSourceRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.