Package co.elastic.clients.elasticsearch.cat

Class SnapshotsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.SnapshotsRequest

public class SnapshotsRequest
extends CatRequestBase

Get snapshot information.

Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotsRequest.Builder	Builder for SnapshotsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<SnapshotsRequest,SnapshotsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.snapshots".

Method Summary

Modifier and Type	Method	Description
final Boolean	ignoreUnavailable()	If true, the response does not include information from unavailable snapshots.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static SnapshotsRequest	of(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
final List<String>	repository()	A comma-separated list of snapshot repositories used to limit the request.
final TimeUnit	time()	Unit used to display time values.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<SnapshotsRequest,SnapshotsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.snapshots".

Method Details

of

public static SnapshotsRequest of(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If true, the response does not include information from unavailable snapshots.

API name: ignore_unavailable

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

repository

public final List<String> repository()

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

API name: repository

time

@Nullable
public final TimeUnit time()

Unit used to display time values.

API name: time