Class ExistsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.ExistsRequest
public class ExistsRequest extends RequestBase
Returns information about whether a document exists in an index.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExistsRequest.Builder
Builder forExistsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<ExistsRequest,BooleanResponse,ErrorResponse>
_ENDPOINT
Endpoint "exists
". -
Method Summary
Modifier and Type Method Description java.lang.String
id()
Required - The document IDjava.lang.String
index()
Required - The name of the indexstatic ExistsRequest
of(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)
java.lang.String
preference()
Specify the node or shard the operation should be performed on (default: random)java.lang.Boolean
realtime()
Specify whether to perform the operation in realtime or search modejava.lang.Boolean
refresh()
Refresh the shard containing the document before performing the operationjava.lang.String
routing()
Specific routing valueSourceConfigParam
source()
True or false to return the _source field or not, or a list of fields to returnjava.util.List<java.lang.String>
sourceExcludes()
A list of fields to exclude from the returned _source fieldjava.util.List<java.lang.String>
sourceIncludes()
A list of fields to extract and return from the _source fieldjava.util.List<java.lang.String>
storedFields()
A comma-separated list of stored fields to return in the responsejava.lang.Long
version()
Explicit version number for concurrency controlVersionType
versionType()
Specific version typeMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "exists
".
-
-
Method Details
-
of
public static ExistsRequest of(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn) -
source
True or false to return the _source field or not, or a list of fields to returnAPI name:
_source
-
sourceExcludes
public final java.util.List<java.lang.String> sourceExcludes()A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
-
sourceIncludes
public final java.util.List<java.lang.String> sourceIncludes()A list of fields to extract and return from the _source fieldAPI name:
_source_includes
-
id
public final java.lang.String id()Required - The document IDAPI name:
id
-
index
public final java.lang.String index()Required - The name of the indexAPI name:
index
-
preference
@Nullable public final java.lang.String preference()Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
realtime
@Nullable public final java.lang.Boolean realtime()Specify whether to perform the operation in realtime or search modeAPI name:
realtime
-
refresh
@Nullable public final java.lang.Boolean refresh()Refresh the shard containing the document before performing the operationAPI name:
refresh
-
routing
@Nullable public final java.lang.String routing()Specific routing valueAPI name:
routing
-
storedFields
public final java.util.List<java.lang.String> storedFields()A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
-
version
@Nullable public final java.lang.Long version()Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-