Package org.opensearch.client.opensearch.snapshot

Class DeleteSnapshotRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>

org.opensearch.client.opensearch.snapshot.DeleteSnapshotRequest.Builder

All Implemented Interfaces:

CopyableBuilder<DeleteSnapshotRequest.Builder,DeleteSnapshotRequest>, MutableBuilder<DeleteSnapshotRequest.Builder,DeleteSnapshotRequest>, ObjectBuilder<DeleteSnapshotRequest>

Enclosing class:

DeleteSnapshotRequest

public static class DeleteSnapshotRequest.Builder
extends RequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>
implements CopyableBuilder<DeleteSnapshotRequest.Builder,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	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final DeleteSnapshotRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
DeleteSnapshotRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DeleteSnapshotRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final DeleteSnapshotRequest.Builder	masterTimeout(Time value)	Deprecated.
final DeleteSnapshotRequest.Builder	repository(String value)	Required - The name of the snapshot repository to delete.
protected DeleteSnapshotRequest.Builder	self()
final DeleteSnapshotRequest.Builder	snapshot(String value)	Required - A comma-separated list of snapshot names to delete from the repository.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public DeleteSnapshotRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<DeleteSnapshotRequest.Builder,DeleteSnapshotRequest>

Returns:

a new builder instance.

self

@Nonnull
protected DeleteSnapshotRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>

clusterManagerTimeout

@Nonnull
public final DeleteSnapshotRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final DeleteSnapshotRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

repository

@Nonnull
public final DeleteSnapshotRequest.Builder repository(String value)

Required - The name of the snapshot repository to delete.

API name: repository

snapshot

@Nonnull
public final DeleteSnapshotRequest.Builder snapshot(String value)

Required - A comma-separated list of snapshot names to delete from the repository.

API name: snapshot

build

@Nonnull
public DeleteSnapshotRequest build()

Builds a DeleteSnapshotRequest.

Specified by:

build in interface ObjectBuilder<DeleteSnapshotRequest>

Throws:

NullPointerException - if some of the required fields are null.