Package co.elastic.clients.elasticsearch.snapshot

Class SnapshotStatusRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.SnapshotStatusRequest

public class SnapshotStatusRequest
extends RequestBase

Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.

WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).

Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<SnapshotStatusRequest,SnapshotStatusResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.status".

Method Summary

Modifier and Type	Method	Description
final Boolean	ignoreUnavailable()	Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
final Time	masterTimeout()	Explicit operation timeout for connection to master node
static SnapshotStatusRequest	of(Function<SnapshotStatusRequest.Builder,ObjectBuilder<SnapshotStatusRequest>> fn)
final String	repository()	A repository name
final List<String>	snapshot()	A comma-separated list of snapshot names

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<SnapshotStatusRequest,SnapshotStatusResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.status".

Method Details

of

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

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown

API name: ignore_unavailable

masterTimeout

@Nullable
public final Time masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

repository

@Nullable
public final String repository()

A repository name

API name: repository

snapshot

public final List<String> snapshot()

A comma-separated list of snapshot names

API name: snapshot