Class GetIndexRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.indices.GetIndexRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<GetIndexRequest>
- Enclosing class:
- GetIndexRequest
public static class GetIndexRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<GetIndexRequest>
Builder for
GetIndexRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetIndexRequest.Builder
allowNoIndices(java.lang.Boolean value)
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.GetIndexRequest
build()
Builds aGetIndexRequest
.GetIndexRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Type of index that wildcard expressions can match.GetIndexRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Type of index that wildcard expressions can match.GetIndexRequest.Builder
features(Feature value, Feature... values)
Return only information on specified index featuresGetIndexRequest.Builder
features(java.util.List<Feature> list)
Return only information on specified index featuresGetIndexRequest.Builder
flatSettings(java.lang.Boolean value)
If true, returns settings in flat format.GetIndexRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
If false, requests that target a missing index return an error.GetIndexRequest.Builder
includeDefaults(java.lang.Boolean value)
If true, return all default settings in the response.GetIndexRequest.Builder
index(java.lang.String value, java.lang.String... values)
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.GetIndexRequest.Builder
index(java.util.List<java.lang.String> list)
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.GetIndexRequest.Builder
local(java.lang.Boolean value)
If true, the request retrieves information from the local node only.GetIndexRequest.Builder
masterTimeout(Time value)
Period to wait for a connection to the master node.GetIndexRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the master node.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
If false, 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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.API name:
allow_no_indices
-
expandWildcards
Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final GetIndexRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
features
Return only information on specified index featuresAPI name:
features
Adds all elements of
list
tofeatures
. -
features
Return only information on specified index featuresAPI name:
features
Adds one or more values to
features
. -
flatSettings
If true, returns settings in flat format.API name:
flat_settings
-
includeDefaults
If true, return all default settings in the response.API name:
include_defaults
-
index
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.API name:
index
Adds all elements of
list
toindex
. -
index
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.API name:
index
Adds one or more values to
index
. -
local
If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.API name:
local
-
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
public final GetIndexRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
-
build
Builds aGetIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<GetIndexRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-