Package org.elasticsearch.action.get

Class GetRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

org.elasticsearch.action.support.single.shard.SingleShardOperationRequestBuilder<GetRequest,GetResponse,GetRequestBuilder>

org.elasticsearch.action.get.GetRequestBuilder

public class GetRequestBuilder
extends SingleShardOperationRequestBuilder<GetRequest,GetResponse,GetRequestBuilder>

A get document action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
GetRequestBuilder(ElasticsearchClient client, GetAction action)
GetRequestBuilder(ElasticsearchClient client, GetAction action, String index)

Method Summary

Modifier and Type	Method	Description
GetRequestBuilder	setFetchSource(boolean fetch)	Indicates whether the response should contain the stored _source.
GetRequestBuilder	setFetchSource(String[] includes, String[] excludes)	Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.
GetRequestBuilder	setFetchSource(String include, String exclude)	Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.
GetRequestBuilder	setId(String id)	Sets the id of the document to fetch.
GetRequestBuilder	setPreference(String preference)	Sets the preference to execute the search.
GetRequestBuilder	setRealtime(boolean realtime)
GetRequestBuilder	setRefresh(boolean refresh)	Should a refresh be executed before this get operation causing the operation to return the latest value.
GetRequestBuilder	setRouting(String routing)	Controls the shard routing of the request.
GetRequestBuilder	setStoredFields(String... fields)	Explicitly specify the fields that will be returned.
GetRequestBuilder	setType(String type)	Sets the type of the document to fetch.
GetRequestBuilder	setVersion(long version)	Sets the version, which will cause the get operation to only be performed if a matching version exists and no changes happened on the doc since then.
GetRequestBuilder	setVersionType(VersionType versionType)	Sets the versioning type.

Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardOperationRequestBuilder

setIndex

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRequestBuilder

public GetRequestBuilder(ElasticsearchClient client,
                         GetAction action)

GetRequestBuilder

public GetRequestBuilder(ElasticsearchClient client,
                         GetAction action,
                         @Nullable
                         String index)

Method Detail

setType

public GetRequestBuilder setType(@Nullable
                                 String type)

Sets the type of the document to fetch. If set to null, will use just the id to fetch the first document matching it.

setId

public GetRequestBuilder setId(String id)

Sets the id of the document to fetch.

setRouting

public GetRequestBuilder setRouting(String routing)

Controls the shard routing of the request. Using this value to hash the shard and not the id.

setPreference

public GetRequestBuilder setPreference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards or a custom value, which guarantees that the same order will be used across different requests.

setStoredFields

public GetRequestBuilder setStoredFields(String... fields)

Explicitly specify the fields that will be returned. By default, the _source field will be returned.

setFetchSource

public GetRequestBuilder setFetchSource(boolean fetch)

Indicates whether the response should contain the stored _source.

Returns:

this for chaining

setFetchSource

public GetRequestBuilder setFetchSource(@Nullable
                                        String include,
                                        @Nullable
                                        String exclude)

Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

include - An optional include (optionally wildcarded) pattern to filter the returned _source

exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source

setFetchSource

public GetRequestBuilder setFetchSource(@Nullable
                                        String[] includes,
                                        @Nullable
                                        String[] excludes)

Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

includes - An optional list of include (optionally wildcarded) pattern to filter the returned _source

excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source

setRefresh

public GetRequestBuilder setRefresh(boolean refresh)

Should a refresh be executed before this get operation causing the operation to return the latest value. Note, heavy get should not set this to true. Defaults to false.

setRealtime

public GetRequestBuilder setRealtime(boolean realtime)

setVersion

public GetRequestBuilder setVersion(long version)

Sets the version, which will cause the get operation to only be performed if a matching version exists and no changes happened on the doc since then.

setVersionType

public GetRequestBuilder setVersionType(VersionType versionType)

Sets the versioning type. Defaults to VersionType.INTERNAL.