Package org.opensearch.client.opensearch.snapshot

Class GetSnapshotRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.GetSnapshotRequest

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GetSnapshotRequest
extends RequestBase

Returns information about a snapshot.

Nested Class Summary

Nested Classes

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

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<GetSnapshotRequest,GetSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.get".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.Boolean	ignoreUnavailable()	If false, the request returns an error for any snapshots that are unavailable.
java.lang.Boolean	includeRepository()	Deprecated.
java.lang.Boolean	indexDetails()	Deprecated.
Time	masterTimeout()	Deprecated.
static GetSnapshotRequest	of(java.util.function.Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)
java.lang.String	repository()	Required - Comma-separated list of snapshot repository names used to limit the request.
java.util.List<java.lang.String>	snapshot()	Required -
java.lang.Boolean	verbose()	If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<GetSnapshotRequest,GetSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.get".

Method Detail

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

ignoreUnavailable

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

If false, the request returns an error for any snapshots that are unavailable.

API name: ignore_unavailable

includeRepository

@Nullable
@Deprecated
public final java.lang.Boolean includeRepository()

Deprecated.

This method is left for compatibility.

indexDetails

@Nullable
@Deprecated
public final java.lang.Boolean indexDetails()

Deprecated.

* This method is left for compatibility.

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

repository

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

Required - Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

API name: repository

snapshot

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

Required -

Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).

• To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
• To get information about any snapshots that are currently running, use _current.

API name: snapshot

verbose

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

If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

API name: verbose

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object