Package org.opensearch.client.opensearch.cat

Class SnapshotsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.SnapshotsRequest

All Implemented Interfaces:

ToCopyableBuilder<SnapshotsRequest.Builder,SnapshotsRequest>

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

Lists all of the snapshots stored in a specific repository.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<SnapshotsRequest,SnapshotsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.snapshots".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static SnapshotsRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time allowed to establish a connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Boolean	ignoreUnavailable()	When true, the response does not include information from unavailable snapshots.
final Time	masterTimeout()	Deprecated.
static SnapshotsRequest	of(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
final List<String>	repository()	A comma-separated list of snapshot repositories used to limit the request.
final TimeUnit	time()	Specifies the time units, for example, 5d or 7h.
SnapshotsRequest.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.cat.CatRequestBase

headers, sort

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<SnapshotsRequest,SnapshotsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.snapshots".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

When true, the response does not include information from unavailable snapshots.

API name: ignore_unavailable

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

repository

@Nonnull
public final List<String> repository()

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.

API name: repository

time

@Nullable
public final TimeUnit time()

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

toBuilder

@Nonnull
public SnapshotsRequest.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<SnapshotsRequest.Builder,SnapshotsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SnapshotsRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object