Class GetIndexRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetIndexRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetIndexRequest.Builder
- All Implemented Interfaces:
WithJson<GetIndexRequest.Builder>
,ObjectBuilder<GetIndexRequest>
- Enclosing class:
- GetIndexRequest
public static class GetIndexRequest.Builder
extends RequestBase.AbstractBuilder<GetIndexRequest.Builder>
implements ObjectBuilder<GetIndexRequest>
Builder for
GetIndexRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal GetIndexRequest.Builder
allowNoIndices
(Boolean value) Ignore if a wildcard expression resolves to no concrete indices (default: false)build()
Builds aGetIndexRequest
.final GetIndexRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard expressions can match.final GetIndexRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard expressions can match.final GetIndexRequest.Builder
flatSettings
(Boolean value) If true, returns settings in flat format.final GetIndexRequest.Builder
ignoreUnavailable
(Boolean value) If false, requests that target a missing index return an error.final GetIndexRequest.Builder
includeDefaults
(Boolean value) If true, return all default settings in the response.final GetIndexRequest.Builder
includeTypeName
(Boolean value) If true, a mapping type is expected in the body of mappings.final GetIndexRequest.Builder
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.final GetIndexRequest.Builder
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.final GetIndexRequest.Builder
If true, the request retrieves information from the local node only.final GetIndexRequest.Builder
masterTimeout
(Time value) Period to wait for a connection to the master node.final GetIndexRequest.Builder
Period to wait for a connection to the master node.protected GetIndexRequest.Builder
self()
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
Ignore if a wildcard expression resolves to no concrete indices (default: false)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
. -
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
-
includeTypeName
If true, a mapping type is expected in the body of mappings.API name:
include_type_name
-
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
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetIndexRequest.Builder>
-
build
Builds aGetIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<GetIndexRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-