Package org.elasticsearch.action.support

Interface WriteRequest<R extends WriteRequest<R>>

All Superinterfaces:

Writeable

All Known Implementing Classes:

BulkRequest, BulkShardRequest, DeleteRequest, IndexRequest, ReplicatedWriteRequest, ResyncReplicationRequest, RetentionLeaseSyncAction.Request, UpdateRequest

public interface WriteRequest<R extends WriteRequest<R>>
extends Writeable

Interface implemented by requests that modify the documents in an index like IndexRequest, UpdateRequest, and BulkRequest. Rather than implement this directly most implementers should extend ReplicatedWriteRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	WriteRequest.RefreshPolicy

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

Writeable.Reader<V>, Writeable.Writer<V>

Method Summary

Modifier and Type	Method	Description
WriteRequest.RefreshPolicy	getRefreshPolicy()	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
default R	setRefreshPolicy(String refreshPolicy)	Parse the refresh policy from a string, only modifying it if the string is non null.
R	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
ActionRequestValidationException	validate()

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Method Details

setRefreshPolicy

R setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

setRefreshPolicy

default R setRefreshPolicy(String refreshPolicy)

Parse the refresh policy from a string, only modifying it if the string is non null. Convenient to use with request parsing.

getRefreshPolicy

WriteRequest.RefreshPolicy getRefreshPolicy()

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

validate

ActionRequestValidationException validate()