Module org.elasticsearch.server

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

Class GetSnapshotsRequestBuilder

java.lang.Object

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

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<GetSnapshotsRequest,GetSnapshotsResponse,GetSnapshotsRequestBuilder>

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

All Implemented Interfaces:

RequestBuilder<GetSnapshotsRequest,GetSnapshotsResponse>

public class GetSnapshotsRequestBuilder
extends MasterNodeOperationRequestBuilder<GetSnapshotsRequest,GetSnapshotsResponse,GetSnapshotsRequestBuilder>

Get snapshots request builder

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
GetSnapshotsRequestBuilder(ElasticsearchClient client, String... repositories)	Constructs the new get snapshot request with specified repositories

Method Summary

Modifier and Type	Method	Description
GetSnapshotsRequestBuilder	addSnapshots(String... snapshots)	Adds additional snapshots to the list of snapshots to return
GetSnapshotsRequestBuilder	setAfter(String after)
GetSnapshotsRequestBuilder	setAfter(GetSnapshotsRequest.After after)
GetSnapshotsRequestBuilder	setCurrentSnapshot()	Makes the request to return the current snapshot
GetSnapshotsRequestBuilder	setFromSortValue(String fromSortValue)
GetSnapshotsRequestBuilder	setIgnoreUnavailable(boolean ignoreUnavailable)	Makes the request ignore unavailable snapshots
GetSnapshotsRequestBuilder	setIncludeIndexNames(boolean indices)
GetSnapshotsRequestBuilder	setOffset(int offset)
GetSnapshotsRequestBuilder	setOrder(SortOrder order)
GetSnapshotsRequestBuilder	setPolicies(String... policies)	Sets slm policy patterns
GetSnapshotsRequestBuilder	setRepositories(String... repositories)	Sets the repository names
GetSnapshotsRequestBuilder	setSize(int size)
GetSnapshotsRequestBuilder	setSnapshots(String... snapshots)	Sets list of snapshots to return
GetSnapshotsRequestBuilder	setSort(GetSnapshotsRequest.SortBy sort)
GetSnapshotsRequestBuilder	setVerbose(boolean verbose)	Set to false to only show the snapshot names and the indices they contain.

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

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

GetSnapshotsRequestBuilder

public GetSnapshotsRequestBuilder(ElasticsearchClient client,
 String... repositories)

Constructs the new get snapshot request with specified repositories

Method Details

setRepositories

public GetSnapshotsRequestBuilder setRepositories(String... repositories)

Sets the repository names

Parameters:

repositories - repository names

Returns:

this builder

setPolicies

public GetSnapshotsRequestBuilder setPolicies(String... policies)

Sets slm policy patterns

Parameters:

policies - slm policy patterns

Returns:

this builder

setSnapshots

public GetSnapshotsRequestBuilder setSnapshots(String... snapshots)

Sets list of snapshots to return

Parameters:

snapshots - list of snapshots

Returns:

this builder

setCurrentSnapshot

public GetSnapshotsRequestBuilder setCurrentSnapshot()

Makes the request to return the current snapshot

Returns:

this builder

addSnapshots

public GetSnapshotsRequestBuilder addSnapshots(String... snapshots)

Adds additional snapshots to the list of snapshots to return

Parameters:

snapshots - additional snapshots

Returns:

this builder

setIgnoreUnavailable

public GetSnapshotsRequestBuilder setIgnoreUnavailable(boolean ignoreUnavailable)

Makes the request ignore unavailable snapshots

Parameters:

ignoreUnavailable - true to ignore unavailable snapshots.

Returns:

this builder

setVerbose

public GetSnapshotsRequestBuilder setVerbose(boolean verbose)

Set to false to only show the snapshot names and the indices they contain. This is useful when the snapshots belong to a cloud-based repository where each blob read is a concern (cost wise and performance wise), as the snapshot names and indices they contain can be retrieved from a single index blob in the repository, whereas the rest of the information requires reading a snapshot metadata file for each snapshot requested. Defaults to true, which returns all information about each requested snapshot.

setAfter

public GetSnapshotsRequestBuilder setAfter(String after)

setAfter

public GetSnapshotsRequestBuilder setAfter(@Nullable
 GetSnapshotsRequest.After after)

setFromSortValue

public GetSnapshotsRequestBuilder setFromSortValue(@Nullable
 String fromSortValue)

setSort

public GetSnapshotsRequestBuilder setSort(GetSnapshotsRequest.SortBy sort)

setSize

public GetSnapshotsRequestBuilder setSize(int size)

setOffset

public GetSnapshotsRequestBuilder setOffset(int offset)

setOrder

public GetSnapshotsRequestBuilder setOrder(SortOrder order)

setIncludeIndexNames

public GetSnapshotsRequestBuilder setIncludeIndexNames(boolean indices)