Package co.elastic.clients.elasticsearch.snapshot

Class DeleteSnapshotRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>

co.elastic.clients.elasticsearch.snapshot.DeleteSnapshotRequest.Builder

All Implemented Interfaces:

WithJson<DeleteSnapshotRequest.Builder>, ObjectBuilder<DeleteSnapshotRequest>

Enclosing class:

DeleteSnapshotRequest

public static class DeleteSnapshotRequest.Builder
extends RequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>
implements ObjectBuilder<DeleteSnapshotRequest>

Builder for DeleteSnapshotRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteSnapshotRequest	build()	Builds a DeleteSnapshotRequest.
final DeleteSnapshotRequest.Builder	masterTimeout(Time value)	The period to wait for the master node.
final DeleteSnapshotRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for the master node.
final DeleteSnapshotRequest.Builder	repository(String value)	Required - The name of the repository to delete a snapshot from.
protected DeleteSnapshotRequest.Builder	self()
final DeleteSnapshotRequest.Builder	snapshot(String value)	Required - A comma-separated list of snapshot names to delete.
final DeleteSnapshotRequest.Builder	waitForCompletion(Boolean value)	If true, the request returns a response when the matching snapshots are all deleted.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

masterTimeout

public final DeleteSnapshotRequest.Builder masterTimeout(@Nullable
 Time value)

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

masterTimeout

public final DeleteSnapshotRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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 DeleteSnapshotRequest.Builder repository(String value)

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

API name: repository

snapshot

public final DeleteSnapshotRequest.Builder snapshot(String value)

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

API name: snapshot

waitForCompletion

public final DeleteSnapshotRequest.Builder waitForCompletion(@Nullable
 Boolean value)

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

self

protected DeleteSnapshotRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>

build

public DeleteSnapshotRequest build()

Builds a DeleteSnapshotRequest.

Specified by:

build in interface ObjectBuilder<DeleteSnapshotRequest>

Throws:

NullPointerException - if some of the required fields are null.