Package org.opensearch.client.opensearch.core

Class ExistsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.ExistsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ExistsRequest>

Enclosing class:

ExistsRequest

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

Builder for ExistsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Required - The document ID

API name: id

index

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

Required - The name of the index

API name: index

preference

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

Specify whether to perform the operation in realtime or search mode

API name: realtime

refresh

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

Refresh the shard containing the document before performing the operation

API name: refresh

routing

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

Specific routing value

API name: routing

storedFields

public final ExistsRequest.Builder storedFields(java.util.List<java.lang.String> list)

A comma-separated list of stored fields to return in the response

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final ExistsRequest.Builder storedFields(java.lang.String value,
                                                java.lang.String... values)

A comma-separated list of stored fields to return in the response

API name: stored_fields

Adds one or more values to storedFields.

version

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

Explicit version number for concurrency control

API name: version

versionType

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

Specific version type

API name: version_type

build

public ExistsRequest build()

Builds a ExistsRequest.

Specified by:

build in interface ObjectBuilder<ExistsRequest>

Throws:

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