Package org.opensearch.client.opensearch.indices

Class DeleteIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.DeleteIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<DeleteIndexRequest>

Enclosing class:

DeleteIndexRequest

public static class DeleteIndexRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<DeleteIndexRequest>

Builder for DeleteIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteIndexRequest.Builder	allowNoIndices(java.lang.Boolean value)	Ignore if a wildcard expression resolves to no concrete indices (default: false)
DeleteIndexRequest	build()	Builds a DeleteIndexRequest.
DeleteIndexRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
DeleteIndexRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
DeleteIndexRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether wildcard expressions should get expanded to open, closed, or hidden indices
DeleteIndexRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether wildcard expressions should get expanded to open, closed, or hidden indices
DeleteIndexRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Ignore unavailable indexes (default: false)
DeleteIndexRequest.Builder	index(java.lang.String value, java.lang.String... values)	Required - A comma-separated list of indices to delete; use _all or * string to delete all indices
DeleteIndexRequest.Builder	index(java.util.List<java.lang.String> list)	Required - A comma-separated list of indices to delete; use _all or * string to delete all indices
DeleteIndexRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
DeleteIndexRequest.Builder	masterTimeout(Time value)	Deprecated.
DeleteIndexRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
DeleteIndexRequest.Builder	timeout(Time value)	Explicit operation timeout

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

allowNoIndices

public final DeleteIndexRequest.Builder allowNoIndices(@Nullable
                                                       java.lang.Boolean value)

Ignore if a wildcard expression resolves to no concrete indices (default: false)

API name: allow_no_indices

expandWildcards

public final DeleteIndexRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

Whether wildcard expressions should get expanded to open, closed, or hidden indices

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final DeleteIndexRequest.Builder expandWildcards(ExpandWildcard value,
                                                        ExpandWildcard... values)

Whether wildcard expressions should get expanded to open, closed, or hidden indices

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

public final DeleteIndexRequest.Builder ignoreUnavailable(@Nullable
                                                          java.lang.Boolean value)

Ignore unavailable indexes (default: false)

API name: ignore_unavailable

index

public final DeleteIndexRequest.Builder index(java.util.List<java.lang.String> list)

Required - A comma-separated list of indices to delete; use _all or * string to delete all indices

API name: index

Adds all elements of list to index.

index

public final DeleteIndexRequest.Builder index(java.lang.String value,
                                              java.lang.String... values)

Required - A comma-separated list of indices to delete; use _all or * string to delete all indices

API name: index

Adds one or more values to index.

masterTimeout

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

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final DeleteIndexRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

public final DeleteIndexRequest.Builder clusterManagerTimeout(@Nullable
                                                              Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final DeleteIndexRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

timeout

public final DeleteIndexRequest.Builder timeout(@Nullable
                                                Time value)

Explicit operation timeout

API name: timeout

timeout

public final DeleteIndexRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

build

public DeleteIndexRequest build()

Builds a DeleteIndexRequest.

Specified by:

build in interface ObjectBuilder<DeleteIndexRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.