Class ExistsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExistsRequest.Builder>
co.elastic.clients.elasticsearch.core.ExistsRequest.Builder
- All Implemented Interfaces:
WithJson<ExistsRequest.Builder>
,ObjectBuilder<ExistsRequest>
- Enclosing class:
- ExistsRequest
public static class ExistsRequest.Builder
extends RequestBase.AbstractBuilder<ExistsRequest.Builder>
implements ObjectBuilder<ExistsRequest>
Builder for
ExistsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aExistsRequest
.final ExistsRequest.Builder
Required - The document IDfinal ExistsRequest.Builder
Required - The name of the indexfinal ExistsRequest.Builder
preference
(String value) Specify the node or shard the operation should be performed on (default: random)final ExistsRequest.Builder
Specify whether to perform the operation in realtime or search modefinal ExistsRequest.Builder
Refresh the shard containing the document before performing the operationfinal ExistsRequest.Builder
Specific routing valueprotected ExistsRequest.Builder
self()
final ExistsRequest.Builder
source
(SourceConfigParam value) True or false to return the _source field or not, or a list of fields to returnfinal ExistsRequest.Builder
True or false to return the _source field or not, or a list of fields to returnfinal ExistsRequest.Builder
sourceExcludes
(String value, String... values) A list of fields to exclude from the returned _source fieldfinal ExistsRequest.Builder
sourceExcludes
(List<String> list) A list of fields to exclude from the returned _source fieldfinal ExistsRequest.Builder
sourceIncludes
(String value, String... values) A list of fields to extract and return from the _source fieldfinal ExistsRequest.Builder
sourceIncludes
(List<String> list) A list of fields to extract and return from the _source fieldfinal ExistsRequest.Builder
storedFields
(String value, String... values) A comma-separated list of stored fields to return in the responsefinal ExistsRequest.Builder
storedFields
(List<String> list) A comma-separated list of stored fields to return in the responsefinal ExistsRequest.Builder
The type of the document (use_all
to fetch the first document matching the ID across all types)final ExistsRequest.Builder
Explicit version number for concurrency controlfinal ExistsRequest.Builder
versionType
(VersionType value) Specific version typeMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
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(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
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
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
A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
Adds one or more values to
storedFields
. -
type
The type of the document (use_all
to fetch the first document matching the ID across all types)API name:
type
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExistsRequest.Builder>
-
build
Builds aExistsRequest
.- Specified by:
build
in interfaceObjectBuilder<ExistsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-