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

public class SnapshotsRequest
extends CatRequestBase

Returns all snapshots 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.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

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<SnapshotsRequest,SnapshotsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.snapshots".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	ignoreUnavailable()	Set to true to ignore unavailable snapshots
static SnapshotsRequest	of(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
java.util.List<java.lang.String>	repository()	Name of repository from which to fetch the snapshot information

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

headers, queryParameters, sort

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

Endpoint "cat.snapshots".

Method Detail

of

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

ignoreUnavailable

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

Set to true to ignore unavailable snapshots

API name: ignore_unavailable

repository

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

Name of repository from which to fetch the snapshot information

API name: repository