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

クラス 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

すべての実装されたインタフェース:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class GetSnapshotsRequest
extends MasterNodeRequest<GetSnapshotsRequest>

Get snapshot request

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	ALL_SNAPSHOTS
static String	CURRENT_SNAPSHOT

クラスから継承されたフィールド org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder

headers

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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)

クラスから継承されたメソッド org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

クラスから継承されたメソッド org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest

getDescription

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder

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

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

ALL_SNAPSHOTS

public static final String ALL_SNAPSHOTS

関連項目:

定数フィールド値

CURRENT_SNAPSHOT

public static final String CURRENT_SNAPSHOT

関連項目:

定数フィールド値

コンストラクタの詳細

GetSnapshotsRequest

public GetSnapshotsRequest()

GetSnapshotsRequest

public GetSnapshotsRequest(String repository,
                           String[] snapshots)

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

パラメータ:

repository - repository name

snapshots - list of snapshots

GetSnapshotsRequest

public GetSnapshotsRequest(String repository)

Constructs a new get snapshots request with given repository name

パラメータ:

repository - repository name

メソッドの詳細

validate

public ActionRequestValidationException validate()

定義:

validate クラス内 ActionRequest<GetSnapshotsRequest>

repository

public GetSnapshotsRequest repository(String repository)

Sets repository name

パラメータ:

repository - repository name

戻り値:

this request

repository

public String repository()

Returns repository name

戻り値:

repository name

snapshots

public String[] snapshots()

Returns the names of the snapshots.

戻り値:

the names of snapshots

snapshots

public GetSnapshotsRequest snapshots(String[] snapshots)

Sets the list of snapshots to be returned

戻り値:

this request

ignoreUnavailable

public GetSnapshotsRequest ignoreUnavailable(boolean ignoreUnavailable)

Set to true to ignore unavailable snapshots

戻り値:

this request

ignoreUnavailable

public boolean ignoreUnavailable()

戻り値:

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

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 MasterNodeRequest<GetSnapshotsRequest>

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 MasterNodeRequest<GetSnapshotsRequest>

例外:

IOException