ReplicationRequest (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<Request>
      - org.elasticsearch.action.support.ChildTaskActionRequest<T>
        
        org.elasticsearch.action.support.replication.ReplicationRequest<T>

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

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

直系の既知のサブクラス:

BulkShardRequest, DeleteRequest, IndexRequest, ShardFlushRequest
```
public class ReplicationRequest<T extends ReplicationRequest<T>>
extends ChildTaskActionRequest<T>
implements IndicesRequest
```

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

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static TimeValue`	`DEFAULT_TIMEOUT`
`protected String`	`index`
`protected ShardId`	`shardId` Target shard the request should execute on.
`protected TimeValue`	`timeout`

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

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

コンストラクタ
修飾子	コンストラクタと説明
	`ReplicationRequest()`
	`ReplicationRequest(ActionRequest request)` Creates a new request that inherits headers and context from the request provided as argument.
	`ReplicationRequest(ActionRequest request, ShardId shardId)` Creates a new request with resolved shard id
`protected`	`ReplicationRequest(T request)` Copy constructor that creates a new request that is a copy of the one provided as an argument.
`protected`	`ReplicationRequest(T request, ActionRequest originalRequest)` Copy constructor that creates a new request that is a copy of the one provided as an argument.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`canHaveDuplicates()` Is this request can potentially be dup on a single shard.
`WriteConsistencyLevel`	`consistencyLevel()`
`T`	`consistencyLevel(WriteConsistencyLevel consistencyLevel)` Sets the consistency level of write.
`Task`	`createTask(long id, String type, String action, TaskId parentTaskId)`
`String`	`getDescription()` Returns optional description of the request to be displayed by the task manager
`String`	`index()`
`T`	`index(String index)`
`String[]`	`indices()` Returns the array of indices that the action relates to
`IndicesOptions`	`indicesOptions()` Returns the indices options used to resolve indices.
`void`	`readFrom(StreamInput in)`
`T`	`setShardId(ShardId shardId)` Sets the target shard id for the request.
`ShardId`	`shardId()`
`TimeValue`	`timeout()`
`T`	`timeout(String timeout)` A timeout to wait if the index operation can't be performed immediately.
`T`	`timeout(TimeValue timeout)` A timeout to wait if the index operation can't be performed immediately.
`String`	`toString()`
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)`

クラスから継承されたメソッド org.elasticsearch.action.support.ChildTaskActionRequest
createTask, setParentTask

クラスから継承されたメソッド 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

- フィールドの詳細
  - DEFAULT_TIMEOUT
```
public static final TimeValue DEFAULT_TIMEOUT
```
  - shardId
```
protected ShardId shardId
```
    Target shard the request should execute on. In case of index and delete requests, shard id gets resolved by the transport action before performing request operation and at request creation time for shard-level bulk, refresh and flush requests.
  - timeout
```
protected TimeValue timeout
```
  - index
```
protected String index
```
- コンストラクタの詳細
  - ReplicationRequest
```
public ReplicationRequest()
```
  - ReplicationRequest
```
public ReplicationRequest(ActionRequest request)
```
    Creates a new request that inherits headers and context from the request provided as argument.
  - ReplicationRequest
```
public ReplicationRequest(ActionRequest request,
                          ShardId shardId)
```
    Creates a new request with resolved shard id
  - ReplicationRequest
```
protected ReplicationRequest(T request)
```
    Copy constructor that creates a new request that is a copy of the one provided as an argument.
  - ReplicationRequest
```
protected ReplicationRequest(T request,
                             ActionRequest originalRequest)
```
    Copy constructor that creates a new 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.
- メソッドの詳細
  - canHaveDuplicates
```
public boolean canHaveDuplicates()
```
    Is this request can potentially be dup on a single shard.
  - timeout
```
public final T timeout(TimeValue timeout)
```
    A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.
  - timeout
```
public final T timeout(String timeout)
```
    A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.
  - timeout
```
public TimeValue timeout()
```
  - index
```
public String index()
```
  - index
```
public final T index(String index)
```
  - indices
```
public String[] indices()
```
    インタフェースからコピーされた説明: IndicesRequest
    
    Returns the array of indices that the action relates to
    
    定義:
    
    indices インタフェース内 IndicesRequest
  - indicesOptions
```
public IndicesOptions indicesOptions()
```
    インタフェースからコピーされた説明: IndicesRequest
    
    Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.
    
    定義:
    
    indicesOptions インタフェース内 IndicesRequest
  - consistencyLevel
```
public WriteConsistencyLevel consistencyLevel()
```
  - shardId
```
@Nullable
public ShardId shardId()
```
    戻り値:
    
    the shardId of the shard where this operation should be executed on. can be null if the shardID has not yet been resolved
  - consistencyLevel
```
public final T consistencyLevel(WriteConsistencyLevel consistencyLevel)
```
    Sets the consistency level of write. Defaults to WriteConsistencyLevel.DEFAULT
  - validate
```
public ActionRequestValidationException validate()
```
    定義:
    
    validate クラス内 ActionRequest<T extends ReplicationRequest<T>>
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    オーバーライド:
    
    readFrom クラス内 ChildTaskActionRequest<T extends ReplicationRequest<T>>
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    オーバーライド:
    
    writeTo クラス内 ChildTaskActionRequest<T extends ReplicationRequest<T>>
    
    例外:
    
    IOException
  - createTask
```
public Task createTask(long id,
                       String type,
                       String action,
                       TaskId parentTaskId)
```
    オーバーライド:
    
    createTask クラス内 ChildTaskActionRequest<T extends ReplicationRequest<T>>
  - setShardId
```
public T setShardId(ShardId shardId)
```
    Sets the target shard id for the request. The shard id is set when a index/delete request is resolved by the transport action
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - getDescription
```
public String getDescription()
```
    クラスからコピーされた説明: TransportRequest
    
    Returns optional description of the request to be displayed by the task manager
    
    オーバーライド:
    
    getDescription クラス内 TransportRequest

クラス ReplicationRequest<T extends ReplicationRequest<T>>

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

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

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

フィールドのサマリー

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

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

メソッドのサマリー

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

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

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

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

フィールドの詳細

DEFAULT_TIMEOUT

shardId

timeout

index

コンストラクタの詳細

ReplicationRequest

ReplicationRequest

ReplicationRequest

ReplicationRequest

ReplicationRequest

メソッドの詳細

canHaveDuplicates

timeout

timeout

timeout

index

index

indices

indicesOptions

consistencyLevel

shardId

consistencyLevel

validate

readFrom

writeTo

createTask

setShardId

toString

getDescription