Package co.elastic.clients.elasticsearch.indices

Class AddBlockRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<AddBlockRequest.Builder>

co.elastic.clients.elasticsearch.indices.AddBlockRequest.Builder

All Implemented Interfaces:

WithJson<AddBlockRequest.Builder>, ObjectBuilder<AddBlockRequest>

Enclosing class:

AddBlockRequest

public static class AddBlockRequest.Builder
extends RequestBase.AbstractBuilder<AddBlockRequest.Builder>
implements ObjectBuilder<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 indices expression resolves into no concrete indices.
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	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final AddBlockRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final AddBlockRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final AddBlockRequest.Builder	index(String value)	Required - A comma separated list of indices to add a block to
final AddBlockRequest.Builder	masterTimeout(Time value)	Specify timeout for connection to master
final AddBlockRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to master
protected AddBlockRequest.Builder	self()
final AddBlockRequest.Builder	timeout(Time value)	Explicit operation timeout
final AddBlockRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

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

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

API name: ignore_unavailable

index

public final AddBlockRequest.Builder index(String value)

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

API name: index

masterTimeout

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

Specify timeout for connection to master

API name: master_timeout

masterTimeout

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

Specify timeout for connection to master

API name: master_timeout

timeout

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

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

self

protected AddBlockRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AddBlockRequest.Builder>

build

public AddBlockRequest build()

Builds a AddBlockRequest.

Specified by:

build in interface ObjectBuilder<AddBlockRequest>

Throws:

NullPointerException - if some of the required fields are null.