Package co.elastic.clients.elasticsearch.snapshot

Class DeleteSnapshotRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.DeleteSnapshotRequest

public class DeleteSnapshotRequest
extends RequestBase

Delete snapshots.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<DeleteSnapshotRequest,DeleteSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.delete".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Explicit operation timeout for connection to master node
static DeleteSnapshotRequest	of(Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)
final String	repository()	Required - A repository name
final String	snapshot()	Required - A comma-separated list of snapshot names
final Boolean	waitForCompletion()	If true, the request returns a response when the matching snapshots are all deleted.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<DeleteSnapshotRequest,DeleteSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.delete".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

repository

public final String repository()

Required - A repository name

API name: repository

snapshot

public final String snapshot()

Required - A comma-separated list of snapshot names

API name: snapshot

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

If true, the request returns a response when the matching snapshots are all deleted. If false, the request returns a response as soon as the deletes are scheduled.

API name: wait_for_completion