GetRequest (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.common.ContextAndHeaderHolder
- - org.elasticsearch.transport.TransportMessage<TransportRequest>
  - - org.elasticsearch.transport.TransportRequest
    - - org.elasticsearch.action.ActionRequest<T>
      - org.elasticsearch.action.support.single.shard.SingleShardRequest<GetRequest>
        
        org.elasticsearch.action.get.GetRequest

すべての実装されたインタフェース:

IndicesRequest, RealtimeRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class GetRequest
extends SingleShardRequest<GetRequest>
implements RealtimeRequest
```
A request to get a document (its source) from an index based on its type (optional) and id. Best created using Requests.getRequest(String).
The operation requires the SingleShardRequest.index(), type(String) and id(String) to be set.

関連項目:

GetResponse, Requests.getRequest(String), Client.get(GetRequest)

ネストされたクラスのサマリー
- クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable

フィールドのサマリー
- クラスから継承されたフィールド org.elasticsearch.action.support.single.shard.SingleShardRequest
  index, INDICES_OPTIONS
- クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder
  headers

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`GetRequest()`
`GetRequest(ActionRequest request, String index)` Constructs a new get request starting from the provided request, meaning that it will inherit its headers and context, and against the specified index.
`GetRequest(GetRequest getRequest, ActionRequest originalRequest)` Copy constructor that creates a new get request that is a copy of the one provided as an argument.
`GetRequest(String index)` Constructs a new get request against the specified index.
`GetRequest(String index, String type, String id)` Constructs a new get request against the specified index with the type and id.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`FetchSourceContext`	`fetchSourceContext()`
`GetRequest`	`fetchSourceContext(FetchSourceContext context)` Allows setting the `FetchSourceContext` for this request, controlling if and how _source should be returned.
`String[]`	`fields()` Explicitly specify the fields that will be returned.
`GetRequest`	`fields(String... fields)` Explicitly specify the fields that will be returned.
`String`	`id()`
`GetRequest`	`id(String id)` Sets the id of the document to fetch.
`boolean`	`ignoreErrorsOnGeneratedFields()`
`GetRequest`	`ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields)`
`GetRequest`	`parent(String parent)` Sets the parent id of this document.
`String`	`preference()`
`GetRequest`	`preference(String preference)` Sets the preference to execute the search.
`void`	`readFrom(StreamInput in)`
`boolean`	`realtime()`
`GetRequest`	`realtime(Boolean realtime)`
`boolean`	`refresh()`
`GetRequest`	`refresh(boolean refresh)` Should a refresh be executed before this get operation causing the operation to return the latest value.
`String`	`routing()`
`GetRequest`	`routing(String routing)` Controls the shard routing of the request.
`String`	`toString()`
`String`	`type()`
`GetRequest`	`type(String type)` Sets the type of the document to fetch.
`ActionRequestValidationException`	`validate()`
`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.
`GetRequest`	`version(long version)`
`VersionType`	`versionType()`
`GetRequest`	`versionType(VersionType versionType)` Sets the versioning type.
`void`	`writeTo(StreamOutput out)`

クラスから継承されたメソッド org.elasticsearch.action.support.single.shard.SingleShardRequest
index, index, indices, indicesOptions, operationThreaded, operationThreaded, validateNonNullIndex

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest
createTask, getDescription

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - GetRequest
```
public GetRequest()
```
  - GetRequest
```
public GetRequest(GetRequest getRequest,
                  ActionRequest originalRequest)
```
    Copy constructor that creates a new get request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.
  - GetRequest
```
public GetRequest(String index)
```
    Constructs a new get request against the specified index. The type(String) and id(String) must be set.
  - GetRequest
```
public GetRequest(ActionRequest request,
                  String index)
```
    Constructs a new get request starting from the provided request, meaning that it will inherit its headers and context, and against the specified index.
  - GetRequest
```
public GetRequest(String index,
                  String type,
                  String id)
```
    Constructs a new get request against the specified index with the type and id.
    
    パラメータ:
    
    index - The index to get the document from
    
    type - The type of the document
    
    id - The id of the document
- メソッドの詳細
  - validate
```
public ActionRequestValidationException validate()
```
    定義:
    
    validate クラス内 ActionRequest<GetRequest>
  - type
```
public GetRequest type(@Nullable
                       String type)
```
    Sets the type of the document to fetch.
  - id
```
public GetRequest id(String id)
```
    Sets the id of the document to fetch.
  - parent
```
public GetRequest parent(String parent)
```
    Sets the parent id of this document. Will simply set the routing to this value, as it is only used for routing with delete requests.
  - routing
```
public GetRequest routing(String routing)
```
    Controls the shard routing of the request. Using this value to hash the shard and not the id.
  - preference
```
public GetRequest preference(String preference)
```
    Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.
  - type
```
public String type()
```
  - id
```
public String id()
```
  - routing
```
public String routing()
```
  - preference
```
public String preference()
```
  - fetchSourceContext
```
public GetRequest fetchSourceContext(FetchSourceContext context)
```
    Allows setting the FetchSourceContext for this request, controlling if and how _source should be returned.
  - fetchSourceContext
```
public FetchSourceContext fetchSourceContext()
```
  - fields
```
public GetRequest fields(String... fields)
```
    Explicitly specify the fields that will be returned. By default, the _source field will be returned.
  - fields
```
public String[] fields()
```
    Explicitly specify the fields that will be returned. By default, the _source field will be returned.
  - refresh
```
public GetRequest refresh(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.
  - refresh
```
public boolean refresh()
```
  - realtime
```
public boolean realtime()
```
  - realtime
```
public GetRequest realtime(Boolean realtime)
```
    定義:
    
    realtime インタフェース内 RealtimeRequest
    
    パラメータ:
    
    realtime - Controls whether this request should be realtime by reading from the translog. If null is specified then whether the operation will be realtime depends on the api of the concrete request subclass.
  - version
```
public 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.
  - version
```
public GetRequest version(long version)
```
  - versionType
```
public GetRequest versionType(VersionType versionType)
```
    Sets the versioning type. Defaults to VersionType.INTERNAL.
  - ignoreErrorsOnGeneratedFields
```
public GetRequest ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields)
```
  - versionType
```
public VersionType versionType()
```
  - ignoreErrorsOnGeneratedFields
```
public boolean ignoreErrorsOnGeneratedFields()
```
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    オーバーライド:
    
    readFrom クラス内 SingleShardRequest<GetRequest>
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    オーバーライド:
    
    writeTo クラス内 SingleShardRequest<GetRequest>
    
    例外:
    
    IOException
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス GetRequest

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.action.IndicesRequest

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.action.support.single.shard.SingleShardRequest

クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.elasticsearch.action.support.single.shard.SingleShardRequest

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

GetRequest

GetRequest

GetRequest

GetRequest

GetRequest

メソッドの詳細

validate

type

id

parent

routing

preference

type

id

routing

preference

fetchSourceContext

fetchSourceContext

fields

fields

refresh

refresh

realtime

realtime

version

version

versionType

ignoreErrorsOnGeneratedFields

versionType

ignoreErrorsOnGeneratedFields

readFrom

writeTo

toString