Package org.opensearch.client.opensearch.snapshot

Class SnapshotStatusRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.SnapshotStatusRequest

All Implemented Interfaces:

ToCopyableBuilder<SnapshotStatusRequest.Builder,SnapshotStatusRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class SnapshotStatusRequest
extends RequestBase
implements ToCopyableBuilder<SnapshotStatusRequest.Builder,SnapshotStatusRequest>

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 final Endpoint<SnapshotStatusRequest,SnapshotStatusResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.status".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static SnapshotStatusRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Boolean	ignoreUnavailable()	Whether to ignore any unavailable snapshots, When false, a SnapshotMissingException is thrown.
final Time	masterTimeout()	Deprecated.
static SnapshotStatusRequest	of(Function<SnapshotStatusRequest.Builder,ObjectBuilder<SnapshotStatusRequest>> fn)
final String	repository()	The name of the repository containing the snapshot.
final List<String>	snapshot()	A comma-separated list of snapshot names.
SnapshotStatusRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

Whether to ignore any unavailable snapshots, When false, a SnapshotMissingException is thrown.

API name: ignore_unavailable

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

repository

@Nullable
public final String repository()

The name of the repository containing the snapshot.

API name: repository

snapshot

@Nonnull
public final List<String> snapshot()

A comma-separated list of snapshot names.

API name: snapshot

toBuilder

@Nonnull
public SnapshotStatusRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotStatusRequest.Builder,SnapshotStatusRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SnapshotStatusRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object