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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDeleteSnapshotRequest.The amount of time to wait for a response from the cluster manager node.clusterManagerTimeout(Time value) The amount of time to wait for a response from the cluster manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.Deprecated.masterTimeout(Time value) Deprecated.repository(String value) Required - The name of the snapshot repository to delete.protected DeleteSnapshotRequest.Builderself()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, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<DeleteSnapshotRequest.Builder,DeleteSnapshotRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<DeleteSnapshotRequest.Builder>
-
clusterManagerTimeout
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.Explicit operation timeout for connection to cluster-manager nodeAPI 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 nodeAPI name:
master_timeout -
repository
Required - The name of the snapshot repository to delete.API name:
repository -
snapshot
Required - A comma-separated list of snapshot names to delete from the repository.API name:
snapshot -
build
Builds aDeleteSnapshotRequest.- Specified by:
buildin interfaceObjectBuilder<DeleteSnapshotRequest>- Throws:
NullPointerException- if some of the required fields are null.
-