Package org.opensearch.client.opensearch.indices

Class AddBlockRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.AddBlockRequest.Builder

All Implemented Interfaces:

ObjectBuilder<AddBlockRequest>

Enclosing class:

AddBlockRequest

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

Builder for AddBlockRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddBlockRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
AddBlockRequest.Builder	block(IndicesBlockOptions value)	Required - The block to add (one of read, write, read_only or metadata)
AddBlockRequest	build()	Builds a AddBlockRequest.
AddBlockRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
AddBlockRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
AddBlockRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
AddBlockRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
AddBlockRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
AddBlockRequest.Builder	index(java.lang.String value)	Required - A comma separated list of indices to add a block to
AddBlockRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
AddBlockRequest.Builder	masterTimeout(Time value)	Deprecated.
AddBlockRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
AddBlockRequest.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 AddBlockRequest.Builder allowNoIndices(@Nullable
                                                    java.lang.Boolean value)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

block

public final AddBlockRequest.Builder block(IndicesBlockOptions value)

Required - The block to add (one of read, write, read_only or metadata)

API name: block

expandWildcards

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

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final AddBlockRequest.Builder index(java.lang.String value)

Required - A comma separated list of indices to add a block to

API name: index

masterTimeout

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

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final AddBlockRequest.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 AddBlockRequest.Builder clusterManagerTimeout(@Nullable
                                                           Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final AddBlockRequest.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 AddBlockRequest.Builder timeout(@Nullable
                                             Time value)

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

build

public AddBlockRequest build()

Builds a AddBlockRequest.

Specified by:

build in interface ObjectBuilder<AddBlockRequest>

Throws:

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