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
-
Method Summary
Modifier and TypeMethodDescriptionfinal OpenRequest.Builder
allowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.build()
Builds aOpenRequest
.final OpenRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.final OpenRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.final OpenRequest.Builder
ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.final OpenRequest.Builder
Required - Comma-separated list of data streams, indices, and aliases used to limit the request.final OpenRequest.Builder
Required - Comma-separated list of data streams, indices, and aliases used to limit the request.final OpenRequest.Builder
masterTimeout
(Time value) Period to wait for a connection to the master node.final OpenRequest.Builder
Period to wait for a connection to the master node.protected OpenRequest.Builder
self()
final OpenRequest.Builder
Period to wait for a response.final OpenRequest.Builder
Period to wait for a response.final OpenRequest.Builder
The number of shard copies that must be active before proceeding with the operation.final OpenRequest.Builder
The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices.API name:
allow_no_indices
-
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
index
Required - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*
). By default, you must explicitly name the indices you using to limit the request. To limit a request using_all
,*
, or other wildcard expressions, change theaction.destructive_requires_name
setting to false. You can update this setting in theelasticsearch.yml
file or using the cluster update settings API.API name:
index
Adds all elements of
list
toindex
. -
index
Required - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*
). By default, you must explicitly name the indices you using to limit the request. To limit a request using_all
,*
, or other wildcard expressions, change theaction.destructive_requires_name
setting to false. You can update this setting in theelasticsearch.yml
file or using the cluster update settings API.API name:
index
Adds one or more values to
index
. -
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
waitForActiveShards
The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
waitForActiveShards
public final OpenRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<OpenRequest.Builder>
-
build
Builds aOpenRequest
.- Specified by:
build
in interfaceObjectBuilder<OpenRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-