public class GetSnapshotsRequest extends MasterNodeRequest<GetSnapshotsRequest>
TransportRequest.Empty
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALL_SNAPSHOTS |
static java.lang.String |
CURRENT_SNAPSHOT |
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
Constructor and Description |
---|
GetSnapshotsRequest() |
GetSnapshotsRequest(java.lang.String repository)
Constructs a new get snapshots request with given repository name
|
GetSnapshotsRequest(java.lang.String repository,
java.lang.String[] snapshots)
Constructs a new get snapshots request with given repository name and list of snapshots
|
Modifier and Type | Method and Description |
---|---|
boolean |
ignoreUnavailable() |
GetSnapshotsRequest |
ignoreUnavailable(boolean ignoreUnavailable)
Set to true to ignore unavailable snapshots
|
void |
readFrom(StreamInput in)
Set this object's fields from a StreamInput.
|
java.lang.String |
repository()
Returns repository name
|
GetSnapshotsRequest |
repository(java.lang.String repository)
Sets repository name
|
java.lang.String[] |
snapshots()
Returns the names of the snapshots.
|
GetSnapshotsRequest |
snapshots(java.lang.String[] snapshots)
Sets the list of snapshots to be returned
|
ActionRequestValidationException |
validate() |
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
createTask, createTask, setParentTask
getDescription
remoteAddress, remoteAddress
public static final java.lang.String ALL_SNAPSHOTS
public static final java.lang.String CURRENT_SNAPSHOT
public GetSnapshotsRequest()
public GetSnapshotsRequest(java.lang.String repository, java.lang.String[] snapshots)
repository
- repository namesnapshots
- list of snapshotspublic GetSnapshotsRequest(java.lang.String repository)
repository
- repository namepublic ActionRequestValidationException validate()
validate
in class ActionRequest<GetSnapshotsRequest>
public GetSnapshotsRequest repository(java.lang.String repository)
repository
- repository namepublic java.lang.String repository()
public java.lang.String[] snapshots()
public GetSnapshotsRequest snapshots(java.lang.String[] snapshots)
public GetSnapshotsRequest ignoreUnavailable(boolean ignoreUnavailable)
public boolean ignoreUnavailable()
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class MasterNodeRequest<GetSnapshotsRequest>
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class MasterNodeRequest<GetSnapshotsRequest>
java.io.IOException