WriteRequest (server 6.8.17 API)

All Superinterfaces:

Streamable

All Known Implementing Classes:

BulkRequest, BulkShardRequest, DeleteRequest, IndexRequest, ReplicatedWriteRequest, ResyncReplicationRequest, RetentionLeaseSyncAction.Request, UpdateRequest
```
public interface WriteRequest<R extends WriteRequest<R>>
extends Streamable
```
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 class WriteRequest.RefreshPolicy

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(java.lang.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.Streamable
readFrom, writeTo

- Method Detail
  - 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(java.lang.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()
```