DeleteAliasRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.indices.DeleteAliasRequest

public class DeleteAliasRequest
extends RequestBase

Deletes an alias.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DeleteAliasRequest.Builder
Builder for DeleteAliasRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static Endpoint<DeleteAliasRequest,DeleteAliasResponse,ErrorResponse> _ENDPOINT
Endpoint "indices.delete_alias".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Time`	`clusterManagerTimeout()`	Specify timeout for connection to cluster-manager
`java.util.List<java.lang.String>`	`index()`	Required - A comma-separated list of index names (supports wildcards); use `_all` for all indices
`Time`	`masterTimeout()`	Deprecated.
`java.util.List<java.lang.String>`	`name()`	Required - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
`static DeleteAliasRequest`	`of(java.util.function.Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)`
`Time`	`timeout()`	Explicit timestamp for the document

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<DeleteAliasRequest,DeleteAliasResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "indices.delete_alias".
- Method Detail
  - of
```
public static DeleteAliasRequest of(java.util.function.Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)
```
  - index
```
public final java.util.List<java.lang.String> index()
```
    Required - A comma-separated list of index names (supports wildcards); use _all for all indices
    API name: index
  - masterTimeout
```
@Deprecated
@Nullable
public final Time masterTimeout()
```
    Deprecated.
    
    Specify timeout for connection to master
    API name: master_timeout
  - clusterManagerTimeout
```
@Nullable
public final Time clusterManagerTimeout()
```
    Specify timeout for connection to cluster-manager
    API name: cluster_manager_timeout
  - name
```
public final java.util.List<java.lang.String> name()
```
    Required - A comma-separated list of aliases to delete (supports wildcards); use _all to delete all aliases for the specified indices.
    API name: name
  - timeout
```
@Nullable
public final Time timeout()
```
    Explicit timestamp for the document
    API name: timeout