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

Returns information about the status of a snapshot.

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