org.elasticsearch.action.admin.cluster.snapshots.get

Class GetSnapshotsRequest

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.master.MasterNodeRequest<GetSnapshotsRequest>

org.elasticsearch.action.admin.cluster.snapshots.get.GetSnapshotsRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class GetSnapshotsRequest
extends MasterNodeRequest<GetSnapshotsRequest>

Get snapshot request

Nested Class Summary

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

TransportRequest.Empty

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SNAPSHOTS
static String	CURRENT_SNAPSHOT

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
GetSnapshotsRequest()
GetSnapshotsRequest(String repository) Constructs a new get snapshots request with given repository name
GetSnapshotsRequest(String repository, String[] snapshots) Constructs a new get snapshots request with given repository name and list of snapshots

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ignoreUnavailable()
GetSnapshotsRequest	ignoreUnavailable(boolean ignoreUnavailable) Set to true to ignore unavailable snapshots
void	readFrom(StreamInput in)
String	repository() Returns repository name
GetSnapshotsRequest	repository(String repository) Sets repository name
String[]	snapshots() Returns the names of the snapshots.
GetSnapshotsRequest	snapshots(String[] snapshots) Sets the list of snapshots to be returned
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

ALL_SNAPSHOTS

public static final String ALL_SNAPSHOTS

See Also:

Constant Field Values

CURRENT_SNAPSHOT

public static final String CURRENT_SNAPSHOT

See Also:

Constant Field Values

Constructor Detail

GetSnapshotsRequest

public GetSnapshotsRequest()

GetSnapshotsRequest

public GetSnapshotsRequest(String repository,
                   String[] snapshots)

Constructs a new get snapshots request with given repository name and list of snapshots

Parameters:

repository - repository name

snapshots - list of snapshots

GetSnapshotsRequest

public GetSnapshotsRequest(String repository)

Constructs a new get snapshots request with given repository name

Parameters:

repository - repository name

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<GetSnapshotsRequest>

repository

public GetSnapshotsRequest repository(String repository)

Sets repository name

Parameters:

repository - repository name

Returns:

this request

repository

public String repository()

Returns repository name

Returns:

repository name

snapshots

public String[] snapshots()

Returns the names of the snapshots.

Returns:

the names of snapshots

snapshots

public GetSnapshotsRequest snapshots(String[] snapshots)

Sets the list of snapshots to be returned

Returns:

this request

ignoreUnavailable

public GetSnapshotsRequest ignoreUnavailable(boolean ignoreUnavailable)

Set to true to ignore unavailable snapshots

Returns:

this request

ignoreUnavailable

public boolean ignoreUnavailable()

Returns:

Whether snapshots should be ignored when unavailable (corrupt or temporarily not fetchable)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<GetSnapshotsRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<GetSnapshotsRequest>

Throws:

IOException