Package org.opensearch.client.opensearch.indices

Class AddBlockRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<AddBlockRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<AddBlockRequest.Builder,AddBlockRequest>, MutableBuilder<AddBlockRequest.Builder,AddBlockRequest>, ObjectBuilder<AddBlockRequest>

Enclosing class:

AddBlockRequest

public static class AddBlockRequest.Builder
extends RequestBase.AbstractBuilder<AddBlockRequest.Builder>
implements CopyableBuilder<AddBlockRequest.Builder,AddBlockRequest>

Builder for AddBlockRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AddBlockRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indexes expression resolves into no concrete indexes.
final AddBlockRequest.Builder	block(IndicesBlockOptions value)	Required - The block to add (one of read, write, read_only or metadata).
AddBlockRequest	build()	Builds a AddBlockRequest.
final AddBlockRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final AddBlockRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
AddBlockRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AddBlockRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final AddBlockRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final AddBlockRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indexes should be ignored when unavailable (missing or closed).
final AddBlockRequest.Builder	index(String value, String... values)	Required - A comma separated list of indexes to add a block to.
final AddBlockRequest.Builder	index(List<String> list)	Required - A comma separated list of indexes to add a block to.
final AddBlockRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final AddBlockRequest.Builder	masterTimeout(Time value)	Deprecated.
protected AddBlockRequest.Builder	self()
final AddBlockRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
final AddBlockRequest.Builder	timeout(Time value)	Explicit operation timeout

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public AddBlockRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<AddBlockRequest.Builder,AddBlockRequest>

Returns:

a new builder instance.

self

@Nonnull
protected AddBlockRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AddBlockRequest.Builder>

allowNoIndices

@Nonnull
public final AddBlockRequest.Builder allowNoIndices(@Nullable
 Boolean value)

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

API name: allow_no_indices

block

@Nonnull
public final AddBlockRequest.Builder block(IndicesBlockOptions value)

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

API name: block

clusterManagerTimeout

@Nonnull
public final AddBlockRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final AddBlockRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

expandWildcards

@Nonnull
public final AddBlockRequest.Builder expandWildcards(List<ExpandWildcard> list)

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

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

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

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

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

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

API name: ignore_unavailable

index

@Nonnull
public final AddBlockRequest.Builder index(List<String> list)

Required - A comma separated list of indexes to add a block to.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final AddBlockRequest.Builder index(String value,
 String... values)

Required - A comma separated list of indexes to add a block to.

API name: index

Adds one or more values to index.

masterTimeout

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

Deprecated.

Specify timeout for connection to cluster manager.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final AddBlockRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to cluster manager.

API name: master_timeout

timeout

@Nonnull
public final AddBlockRequest.Builder timeout(@Nullable
 Time value)

Explicit operation timeout

API name: timeout

timeout

@Nonnull
public final AddBlockRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

build

@Nonnull
public AddBlockRequest build()

Builds a AddBlockRequest.

Specified by:

build in interface ObjectBuilder<AddBlockRequest>

Throws:

NullPointerException - if some of the required fields are null.