Package org.opensearch.client.opensearch.snapshot

Class DeleteSnapshotRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.DeleteSnapshotRequest

public class DeleteSnapshotRequest
extends RequestBase

Deletes a snapshot.

Nested Class Summary

Nested Classes

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

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<DeleteSnapshotRequest,DeleteSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.delete".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Explicit operation timeout for connection to cluster-manager node
Time	masterTimeout()	Explicit operation timeout for connection to master node
static DeleteSnapshotRequest	of(java.util.function.Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)
java.lang.String	repository()	Required - A repository name
java.lang.String	snapshot()	Required - A snapshot name

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<DeleteSnapshotRequest,DeleteSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.delete".

Method Detail

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

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

public final java.lang.String repository()

Required - A repository name

API name: repository

snapshot

public final java.lang.String snapshot()

Required - A snapshot name

API name: snapshot