java.lang.Object

org.opensearch.action.support.single.instance.InstanceShardOperationRequest<Request>

All Implemented Interfaces:: IndicesRequest, Writeable, TaskAwareRequest

Direct Known Subclasses:: UpdateRequest

public abstract class InstanceShardOperationRequest<Request extends InstanceShardOperationRequest<Request>>
extends ActionRequest
implements IndicesRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest
TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest
IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type	Field	Description
`static org.opensearch.common.unit.TimeValue`	`DEFAULT_TIMEOUT`
`protected java.lang.String`	`index`
`protected ShardId`	`shardId`
`protected org.opensearch.common.unit.TimeValue`	`timeout`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`InstanceShardOperationRequest()`
	`InstanceShardOperationRequest(java.lang.String index)`
`protected`	`InstanceShardOperationRequest(ShardId shardId, StreamInput in)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`concreteIndex()`
`java.lang.String`	`index()`
`Request`	`index(java.lang.String index)`
`java.lang.String[]`	`indices()`	Returns the array of indices that the action relates to
`IndicesOptions`	`indicesOptions()`	Returns the indices options used to resolve indices.
`org.opensearch.common.unit.TimeValue`	`timeout()`
`Request`	`timeout(java.lang.String timeout)`	A timeout to wait if the index operation can't be performed immediately.
`Request`	`timeout(org.opensearch.common.unit.TimeValue timeout)`	A timeout to wait if the index operation can't be performed immediately.
`ActionRequestValidationException`	`validate()`
`void`	`writeThin(StreamOutput out)`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details
- DEFAULT_TIMEOUT
  
  public static final org.opensearch.common.unit.TimeValue DEFAULT_TIMEOUT
- timeout
  
  protected org.opensearch.common.unit.TimeValue timeout
- index
  
  protected java.lang.String index
- shardId
  
  protected ShardId shardId
Constructor Details
- InstanceShardOperationRequest
  
  protected InstanceShardOperationRequest()
- InstanceShardOperationRequest
  
  protected InstanceShardOperationRequest(@Nullable ShardId shardId, StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- InstanceShardOperationRequest
  
  public InstanceShardOperationRequest(java.lang.String index)
Method Details
- validate
  
  public ActionRequestValidationException validate()
  
  Specified by:
  
  validate in class ActionRequest
- index
  
  public java.lang.String index()
- indices
  
  public java.lang.String[] indices()
  
  Description copied from interface: IndicesRequest
  
  Returns the array of indices that the action relates to
  
  Specified by:
  
  indices in interface IndicesRequest
- indicesOptions
  
  public IndicesOptions indicesOptions()
  
  Description copied from interface: 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.
  
  Specified by:
  
  indicesOptions in interface IndicesRequest
- index
  
  public final Request index(java.lang.String index)
- timeout
  
  public org.opensearch.common.unit.TimeValue timeout()
- timeout
  
  public final Request timeout(org.opensearch.common.unit.TimeValue timeout)
  
  A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.
- timeout
  
  public final Request timeout(java.lang.String timeout)
  
  A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.
- concreteIndex
  
  public java.lang.String concreteIndex()
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Overrides:
  
  writeTo in class ActionRequest
  
  Throws:
  
  java.io.IOException
- writeThin
  
  public void writeThin(StreamOutput out) throws java.io.IOException
  
  Throws:
  
  java.io.IOException

Class InstanceShardOperationRequest<Request extends InstanceShardOperationRequest<Request>>

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable