Package org.elasticsearch.action.admin.cluster.snapshots.status

Class SnapshotsStatusRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<SnapshotsStatusRequest,SnapshotsStatusResponse,SnapshotsStatusRequestBuilder>

org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusRequestBuilder

public class SnapshotsStatusRequestBuilder
extends MasterNodeOperationRequestBuilder<SnapshotsStatusRequest,SnapshotsStatusResponse,SnapshotsStatusRequestBuilder>

Snapshots status request builder

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
SnapshotsStatusRequestBuilder(ElasticsearchClient client, SnapshotsStatusAction action)	Constructs the new snapshot status request
SnapshotsStatusRequestBuilder(ElasticsearchClient client, SnapshotsStatusAction action, String repository)	Constructs the new snapshot status request with specified repository

Method Summary

Modifier and Type	Method	Description
SnapshotsStatusRequestBuilder	addSnapshots(String... snapshots)	Adds additional snapshots to the list of snapshots to return
SnapshotsStatusRequestBuilder	setIgnoreUnavailable(boolean ignoreUnavailable)	Set to true to ignore unavailable snapshots, instead of throwing an exception.
SnapshotsStatusRequestBuilder	setRepository(String repository)	Sets the repository name
SnapshotsStatusRequestBuilder	setSnapshots(String... snapshots)	Sets list of snapshots to return

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

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotsStatusRequestBuilder

public SnapshotsStatusRequestBuilder(ElasticsearchClient client,
                                     SnapshotsStatusAction action)

Constructs the new snapshot status request

SnapshotsStatusRequestBuilder

public SnapshotsStatusRequestBuilder(ElasticsearchClient client,
                                     SnapshotsStatusAction action,
                                     String repository)

Constructs the new snapshot status request with specified repository

Method Detail

setRepository

public SnapshotsStatusRequestBuilder setRepository(String repository)

Sets the repository name

Parameters:

repository - repository name

Returns:

this builder

setSnapshots

public SnapshotsStatusRequestBuilder setSnapshots(String... snapshots)

Sets list of snapshots to return

Parameters:

snapshots - list of snapshots

Returns:

this builder

addSnapshots

public SnapshotsStatusRequestBuilder addSnapshots(String... snapshots)

Adds additional snapshots to the list of snapshots to return

Parameters:

snapshots - additional snapshots

Returns:

this builder

setIgnoreUnavailable

public SnapshotsStatusRequestBuilder setIgnoreUnavailable(boolean ignoreUnavailable)

Set to true to ignore unavailable snapshots, instead of throwing an exception. Defaults to false, which means unavailable snapshots cause an exception to be thrown.

Parameters:

ignoreUnavailable - whether to ignore unavailable snapshots.

Returns:

this builder