Package org.opensearch.client.opensearch.core

Class GetRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.GetRequest

public class GetRequest
extends RequestBase

Returns a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetRequest.Builder	Builder for GetRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static SimpleEndpoint<GetRequest,?>	_ENDPOINT	Endpoint "get".

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<GetRequest,GetResponse<TDocument>,ErrorResponse>	createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "get" endpoint.
java.lang.String	id()	Required - Unique identifier of the document.
java.lang.String	index()	Required - Name of the index that contains the document.
static GetRequest	of(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)
java.lang.String	preference()	Specifies the node or shard the operation should be performed on.
java.lang.Boolean	realtime()	Boolean) If true, the request is real-time as opposed to near-real-time.
java.lang.Boolean	refresh()	If true, Elasticsearch refreshes the affected shards to make this operation visible to search.
java.lang.String	routing()	Target the specified primary shard.
SourceConfigParam	source()	True or false to return the _source field or not, or a list of fields to return.
java.util.List<java.lang.String>	sourceExcludes()	A comma-separated list of source fields to exclude in the response.
java.util.List<java.lang.String>	sourceIncludes()	A comma-separated list of source fields to include in the response.
java.util.List<java.lang.String>	storedFields()	A comma-separated list of stored fields to return in the response
java.lang.Long	version()	Explicit version number for concurrency control.
VersionType	versionType()	Specific version type: internal, external, external_gte.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final SimpleEndpoint<GetRequest,?> _ENDPOINT

Endpoint "get".

Method Detail

of

public static GetRequest of(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)

source

@Nullable
public final SourceConfigParam source()

True or false to return the _source field or not, or a list of fields to return.

API name: _source

sourceExcludes

public final java.util.List<java.lang.String> sourceExcludes()

A comma-separated list of source fields to exclude in the response.

API name: _source_excludes

sourceIncludes

public final java.util.List<java.lang.String> sourceIncludes()

A comma-separated list of source fields to include in the response.

API name: _source_includes

id

public final java.lang.String id()

Required - Unique identifier of the document.

API name: id

index

public final java.lang.String index()

Required - Name of the index that contains the document.

API name: index

preference

@Nullable
public final java.lang.String preference()

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

realtime

@Nullable
public final java.lang.Boolean realtime()

Boolean) If true, the request is real-time as opposed to near-real-time.

API name: realtime

refresh

@Nullable
public final java.lang.Boolean 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

@Nullable
public final java.lang.String routing()

Target the specified primary shard.

API name: routing

storedFields

public final java.util.List<java.lang.String> storedFields()

A comma-separated list of stored fields to return in the response

API name: stored_fields

version

@Nullable
public final java.lang.Long 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

@Nullable
public final VersionType versionType()

Specific version type: internal, external, external_gte.

API name: version_type

createGetEndpoint

public static <TDocument> Endpoint<GetRequest,GetResponse<TDocument>,ErrorResponse> createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "get" endpoint.