Class GetSourceRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.GetSourceRequest
Returns the source of a document.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final SimpleEndpoint<GetSourceRequest,
?> Endpoint "get_source
". -
Method Summary
Modifier and TypeMethodDescriptionstatic <TDocument>
Endpoint<GetSourceRequest,GetSourceResponse<TDocument>, ErrorResponse> createGetSourceEndpoint
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "get_source
" endpoint.final String
id()
Required - Unique identifier of the document.final String
index()
Required - Name of the index that contains the document.static GetSourceRequest
final String
Specifies the node or shard the operation should be performed on.final Boolean
realtime()
Boolean) If true, the request is real-time as opposed to near-real-time.final Boolean
refresh()
If true, Elasticsearch refreshes the affected shards to make this operation visible to search.final String
routing()
Target the specified primary shard.final SourceConfigParam
source()
True or false to return the _source field or not, or a list of fields to return.A comma-separated list of source fields to exclude in the response.A comma-separated list of source fields to include in the response.API name:stored_fields
final String
type()
Deprecated.7.0.0final Long
version()
Explicit version number for concurrency control.final VersionType
Specific version type: internal, external, external_gte.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "get_source
".
-
-
Method Details
-
of
public static GetSourceRequest of(Function<GetSourceRequest.Builder, ObjectBuilder<GetSourceRequest>> fn) -
source
True or false 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
-
sourceIncludes
A comma-separated list of source fields to include in the response.API name:
_source_includes
-
id
Required - Unique identifier of the document.API name:
id
-
index
Required - Name of the index that contains the document.API name:
index
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
realtime
Boolean) If true, the request is real-time as opposed to near-real-time.API name:
realtime
-
refresh
If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.API name:
refresh
-
routing
Target the specified primary shard.API name:
routing
-
storedFields
API name:stored_fields
-
type
Deprecated.7.0.0The type of the document.API name:
type
-
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: internal, external, external_gte.API name:
version_type
-
createGetSourceEndpoint
public static <TDocument> Endpoint<GetSourceRequest,GetSourceResponse<TDocument>, createGetSourceEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "get_source
" endpoint.
-