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 - Identifier of the document.final ExistsRequest.Builder
Required - Comma-separated list of data streams, indices, and aliases.final ExistsRequest.Builder
preference
(String value) Specifies the node or shard the operation should be performed on.final ExistsRequest.Builder
Iftrue
, the request is real-time as opposed to near-real-time.final ExistsRequest.Builder
Iftrue
, Elasticsearch refreshes all shards involved in the delete by query after the request completes.final ExistsRequest.Builder
Target the specified primary shard.protected ExistsRequest.Builder
self()
final ExistsRequest.Builder
source
(SourceConfigParam value) true
orfalse
to return the_source
field or not, or a list of fields to return.final ExistsRequest.Builder
true
orfalse
to return the_source
field or not, or a list of fields to return.final ExistsRequest.Builder
sourceExcludes
(String value, String... values) A comma-separated list of source fields to exclude in the response.final ExistsRequest.Builder
sourceExcludes
(List<String> list) A comma-separated list of source fields to exclude in the response.final ExistsRequest.Builder
sourceIncludes
(String value, String... values) A comma-separated list of source fields to include in the response.final ExistsRequest.Builder
sourceIncludes
(List<String> list) A comma-separated list of source fields to include in the response.final ExistsRequest.Builder
storedFields
(String value, String... values) List of stored fields to return as part of a hit.final ExistsRequest.Builder
storedFields
(List<String> list) List of stored fields to return as part of a hit.final ExistsRequest.Builder
Explicit version number for concurrency control.final ExistsRequest.Builder
versionType
(VersionType value) Specific version type:external
,external_gte
.Methods 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
orfalse
to return the_source
field or not, or a list of fields to return.API name:
_source
-
source
public final ExistsRequest.Builder source(Function<SourceConfigParam.Builder, ObjectBuilder<SourceConfigParam>> fn) true
orfalse
to return the_source
field or not, or a list of fields to return.API name:
_source
-
sourceExcludes
A comma-separated list of source fields to exclude in the response.API name:
_source_excludes
Adds all elements of
list
tosourceExcludes
. -
sourceExcludes
A comma-separated list of source fields to exclude in the response.API name:
_source_excludes
Adds one or more values to
sourceExcludes
. -
sourceIncludes
A comma-separated list of source fields to include in the response.API name:
_source_includes
Adds all elements of
list
tosourceIncludes
. -
sourceIncludes
A comma-separated list of source fields to include in the response.API name:
_source_includes
Adds one or more values to
sourceIncludes
. -
id
Required - Identifier of the document.API name:
id
-
index
Required - Comma-separated list of data streams, indices, and aliases. Supports wildcards (*
).API name:
index
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
realtime
Iftrue
, the request is real-time as opposed to near-real-time.API name:
realtime
-
refresh
Iftrue
, Elasticsearch refreshes all shards involved in the delete by query after the request completes.API name:
refresh
-
routing
Target the specified primary shard.API name:
routing
-
storedFields
List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the_source
parameter defaults to false.API name:
stored_fields
Adds all elements of
list
tostoredFields
. -
storedFields
List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the_source
parameter defaults to false.API name:
stored_fields
Adds one or more values to
storedFields
. -
version
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
Specific version type:external
,external_gte
.API 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.
-