Class DeleteAliasRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<DeleteAliasRequest.Builder>
org.opensearch.client.opensearch.indices.DeleteAliasRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<DeleteAliasRequest.Builder,,DeleteAliasRequest> MutableBuilder<DeleteAliasRequest.Builder,,DeleteAliasRequest> ObjectBuilder<DeleteAliasRequest>
- Enclosing class:
DeleteAliasRequest
public static class DeleteAliasRequest.Builder
extends RequestBase.AbstractBuilder<DeleteAliasRequest.Builder>
implements CopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest>
Builder for
DeleteAliasRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDeleteAliasRequest.Operation timeout for connection to cluster-manager node.clusterManagerTimeout(Time value) Operation timeout for connection to cluster-manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.Required - Comma-separated list of data streams or indexes used to limit the request.Required - Comma-separated list of data streams or indexes used to limit the request.Deprecated.masterTimeout(Time value) Deprecated.Required - Comma-separated list of aliases to remove.Required - Comma-separated list of aliases to remove.protected DeleteAliasRequest.Builderself()Period to wait for a response.Period to wait for a response.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<DeleteAliasRequest.Builder,DeleteAliasRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<DeleteAliasRequest.Builder>
-
clusterManagerTimeout
Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
clusterManagerTimeout
@Nonnull public final DeleteAliasRequest.Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
index
Required - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).API name:
indexAdds all elements of
listtoindex. -
index
Required - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).API name:
indexAdds one or more values to
index. -
masterTimeout
Deprecated.Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout -
masterTimeout
@Deprecated @Nonnull public final DeleteAliasRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Deprecated.Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout -
name
Required - Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use*or_all.API name:
nameAdds all elements of
listtoname. -
name
Required - Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use*or_all.API name:
nameAdds one or more values to
name. -
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout -
timeout
@Nonnull public final DeleteAliasRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout -
build
Builds aDeleteAliasRequest.- Specified by:
buildin interfaceObjectBuilder<DeleteAliasRequest>- Throws:
NullPointerException- if some of the required fields are null.
-