Class StateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<StateRequest.Builder>
co.elastic.clients.elasticsearch.cluster.StateRequest.Builder
- All Implemented Interfaces:
WithJson<StateRequest.Builder>
,ObjectBuilder<StateRequest>
- Enclosing class:
- StateRequest
public static class StateRequest.Builder
extends RequestBase.AbstractBuilder<StateRequest.Builder>
implements ObjectBuilder<StateRequest>
Builder for
StateRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal StateRequest.Builder
allowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aStateRequest
.final StateRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.final StateRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.final StateRequest.Builder
flatSettings
(Boolean value) Return settings in flat format (default: false)final StateRequest.Builder
ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)final StateRequest.Builder
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesfinal StateRequest.Builder
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesfinal StateRequest.Builder
Return local information, do not retrieve the state from master node (default: false)final StateRequest.Builder
masterTimeout
(Time value) Specify timeout for connection to masterfinal StateRequest.Builder
Specify timeout for connection to masterfinal StateRequest.Builder
Limit the information returned to the specified metricsfinal StateRequest.Builder
Limit the information returned to the specified metricsprotected StateRequest.Builder
self()
final StateRequest.Builder
waitForMetadataVersion
(Long value) Wait for the metadata version to be equal or greater than the specified metadata versionfinal StateRequest.Builder
waitForTimeout
(Time value) The maximum time to wait for wait_for_metadata_version before timing outfinal StateRequest.Builder
The maximum time to wait for wait_for_metadata_version before timing outMethods 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
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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
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
. -
flatSettings
Return settings in flat format (default: false)API name:
flat_settings
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
index
. -
local
Return local information, do not retrieve the state from master node (default: false)API name:
local
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
metric
Limit the information returned to the specified metricsAPI name:
metric
Adds all elements of
list
tometric
. -
metric
Limit the information returned to the specified metricsAPI name:
metric
Adds one or more values to
metric
. -
waitForMetadataVersion
Wait for the metadata version to be equal or greater than the specified metadata versionAPI name:
wait_for_metadata_version
-
waitForTimeout
The maximum time to wait for wait_for_metadata_version before timing outAPI name:
wait_for_timeout
-
waitForTimeout
The maximum time to wait for wait_for_metadata_version before timing outAPI name:
wait_for_timeout
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<StateRequest.Builder>
-
build
Builds aStateRequest
.- Specified by:
build
in interfaceObjectBuilder<StateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-