Class StateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.cluster.StateRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<StateRequest>
- Enclosing class:
- StateRequest
public static class StateRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<StateRequest>
Builder for
StateRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description StateRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.StateRequest
build()
Builds aStateRequest
.StateRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Whether to expand wildcard expression to concrete indices that are open, closed or both.StateRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Whether to expand wildcard expression to concrete indices that are open, closed or both.StateRequest.Builder
flatSettings(java.lang.Boolean value)
Return settings in flat format (default: false)StateRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)StateRequest.Builder
index(java.lang.String value, java.lang.String... values)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesStateRequest.Builder
index(java.util.List<java.lang.String> list)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesStateRequest.Builder
local(java.lang.Boolean value)
Return local information, do not retrieve the state from master node (default: false)StateRequest.Builder
masterTimeout(Time value)
Specify timeout for connection to masterStateRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Specify timeout for connection to masterStateRequest.Builder
metric(java.lang.String value, java.lang.String... values)
Limit the information returned to the specified metricsStateRequest.Builder
metric(java.util.List<java.lang.String> list)
Limit the information returned to the specified metricsStateRequest.Builder
waitForMetadataVersion(java.lang.Long value)
Wait for the metadata version to be equal or greater than the specified metadata versionStateRequest.Builder
waitForTimeout(Time value)
The maximum time to wait for wait_for_metadata_version before timing outStateRequest.Builder
waitForTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
The maximum time to wait for wait_for_metadata_version before timing outMethods 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
-
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
public final StateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
public final StateRequest.Builder waitForTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)The maximum time to wait for wait_for_metadata_version before timing outAPI name:
wait_for_timeout
-
build
Builds aStateRequest
.- Specified by:
build
in interfaceObjectBuilder<StateRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-