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()	The period to wait for the master node.
static DeleteSnapshotRequest	of(Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)
final String	repository()	Required - The name of the repository to delete a snapshot from.
final String	snapshot()	Required - A comma-separated list of snapshot names to delete.

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()

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

repository

public final String repository()

Required - The name of the repository to delete a snapshot from.

API name: repository

snapshot

public final String snapshot()

Required - A comma-separated list of snapshot names to delete. It also accepts wildcards (*).

API name: snapshot