Class DeleteAliasRequest
java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.DeleteAliasRequest
- All Implemented Interfaces:
ToCopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class DeleteAliasRequest
extends RequestBase
implements ToCopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest>
Deletes an alias.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Endpoint<DeleteAliasRequest, DeleteAliasResponse, ErrorResponse> Endpoint "indices.delete_alias". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) static DeleteAliasRequest.Builderbuilder()final TimeOperation timeout for connection to cluster-manager node.booleaninthashCode()index()Required - Comma-separated list of data streams or indexes used to limit the request.final TimeDeprecated.name()Required - Comma-separated list of aliases to remove.static DeleteAliasRequestfinal Timetimeout()Period to wait for a response.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_ENDPOINT
Endpoint "indices.delete_alias".
-
-
Method Details
-
of
public static DeleteAliasRequest of(Function<DeleteAliasRequest.Builder, ObjectBuilder<DeleteAliasRequest>> fn) -
clusterManagerTimeout
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:
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 -
name
Required - Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use*or_all.API name:
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 -
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest> - Returns:
- a new builder instance.
-
builder
-
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-