Package co.elastic.clients.elasticsearch.indices

Class OpenRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.OpenRequest.Builder

All Implemented Interfaces:

WithJson<OpenRequest.Builder>, ObjectBuilder<OpenRequest>

Enclosing class:

OpenRequest

public static class OpenRequest.Builder
extends RequestBase.AbstractBuilder<OpenRequest.Builder>
implements ObjectBuilder<OpenRequest>

Builder for OpenRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final OpenRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
OpenRequest	build()	Builds a OpenRequest.
final OpenRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final OpenRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final OpenRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final OpenRequest.Builder	index(String value, String... values)	Required - A comma separated list of indices to open
final OpenRequest.Builder	index(List<String> list)	Required - A comma separated list of indices to open
final OpenRequest.Builder	masterTimeout(Time value)	Specify timeout for connection to master
final OpenRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to master
protected OpenRequest.Builder	self()
final OpenRequest.Builder	timeout(Time value)	Explicit operation timeout
final OpenRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
final OpenRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of active shards to wait for before the operation returns.
final OpenRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Sets the number of active shards to wait for before the operation returns.

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 OpenRequest.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

expandWildcards

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

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

API name: ignore_unavailable

index

public final OpenRequest.Builder index(List<String> list)

Required - A comma separated list of indices to open

API name: index

Adds all elements of list to index.

index

public final OpenRequest.Builder index(String value,
 String... values)

Required - A comma separated list of indices to open

API name: index

Adds one or more values to index.

masterTimeout

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

Specify timeout for connection to master

API name: master_timeout

masterTimeout

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

Specify timeout for connection to master

API name: master_timeout

timeout

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

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

waitForActiveShards

public final OpenRequest.Builder waitForActiveShards(@Nullable
 WaitForActiveShards value)

Sets the number of active shards to wait for before the operation returns.

API name: wait_for_active_shards

waitForActiveShards

public final OpenRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

Sets the number of active shards to wait for before the operation returns.

API name: wait_for_active_shards

self

protected OpenRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<OpenRequest.Builder>

build

public OpenRequest build()

Builds a OpenRequest.

Specified by:

build in interface ObjectBuilder<OpenRequest>

Throws:

NullPointerException - if some of the required fields are null.