Package org.opensearch.client.opensearch.snapshot

Class SnapshotStatusRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.SnapshotStatusRequest

public class SnapshotStatusRequest
extends RequestBase

Returns information about the status of a snapshot.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<SnapshotStatusRequest,SnapshotStatusResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.status".

Method Detail

of

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

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

repository

@Nullable
public final java.lang.String repository()

A repository name

API name: repository

snapshot

public final java.util.List<java.lang.String> snapshot()

A comma-separated list of snapshot names

API name: snapshot