Class ExistsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.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 aExistsRequest
.ExistsRequest.Builder
id(java.lang.String value)
Required - The document IDExistsRequest.Builder
index(java.lang.String value)
Required - The name of the indexExistsRequest.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 modeExistsRequest.Builder
refresh(java.lang.Boolean value)
Refresh the shard containing the document before performing the operationExistsRequest.Builder
routing(java.lang.String value)
Specific routing valueExistsRequest.Builder
source(SourceConfigParam value)
True or false to return the _source field or not, or a list of fields to returnExistsRequest.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 returnExistsRequest.Builder
sourceExcludes(java.lang.String value, java.lang.String... values)
A list of fields to exclude from the returned _source fieldExistsRequest.Builder
sourceExcludes(java.util.List<java.lang.String> list)
A list of fields to exclude from the returned _source fieldExistsRequest.Builder
sourceIncludes(java.lang.String value, java.lang.String... values)
A list of fields to extract and return from the _source fieldExistsRequest.Builder
sourceIncludes(java.util.List<java.lang.String> list)
A list of fields to extract and return from the _source fieldExistsRequest.Builder
storedFields(java.lang.String value, java.lang.String... values)
A comma-separated list of stored fields to return in the responseExistsRequest.Builder
storedFields(java.util.List<java.lang.String> list)
A comma-separated list of stored fields to return in the responseExistsRequest.Builder
version(java.lang.Long value)
Explicit version number for concurrency controlExistsRequest.Builder
versionType(VersionType value)
Specific version typeMethods 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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
source
True or false to return the _source field or not, or a list of fields to returnAPI 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 returnAPI name:
_source
-
sourceExcludes
A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
Adds all elements of
list
tosourceExcludes
. -
sourceExcludes
public final ExistsRequest.Builder sourceExcludes(java.lang.String value, java.lang.String... values)A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
Adds one or more values to
sourceExcludes
. -
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includes
Adds all elements of
list
tosourceIncludes
. -
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 fieldAPI name:
_source_includes
Adds one or more values to
sourceIncludes
. -
id
Required - The document IDAPI name:
id
-
index
Required - The name of the indexAPI name:
index
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
realtime
Specify whether to perform the operation in realtime or search modeAPI name:
realtime
-
refresh
Refresh the shard containing the document before performing the operationAPI name:
refresh
-
routing
Specific routing valueAPI name:
routing
-
storedFields
A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
Adds all elements of
list
tostoredFields
. -
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 responseAPI name:
stored_fields
Adds one or more values to
storedFields
. -
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
build
Builds aExistsRequest
.- Specified by:
build
in interfaceObjectBuilder<ExistsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-