Class GetRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
public final class GetRequest extends RequestBase
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetRequest.Builder
Builder forGetRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetRequest,GetResponse,ElasticsearchError>
ENDPOINT
Endpoint "indices.get
". -
Constructor Summary
Constructors Constructor Description GetRequest(GetRequest.Builder builder)
GetRequest(java.util.function.Function<GetRequest.Builder,GetRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Ignore if a wildcard expression resolves to no concrete indices (default: false)java.util.List<ExpandWildcardOptions>
expandWildcards()
Type of index that wildcard expressions can match.java.lang.Boolean
flatSettings()
If true, returns settings in flat format.java.lang.Boolean
ignoreUnavailable()
If false, requests that target a missing index return an error.java.lang.Boolean
includeDefaults()
If true, return all default settings in the response.java.lang.Boolean
includeTypeName()
If true, a mapping type is expected in the body of mappings.java.util.List<java.lang.String>
index()
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.java.lang.Boolean
local()
If true, the request retrieves information from the local node only.java.lang.String
masterTimeout()
Period to wait for a connection to the master node.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ENDPOINT
Endpoint "indices.get
".
-
-
Constructor Details
-
GetRequest
-
GetRequest
-
-
Method Details
-
index
public java.util.List<java.lang.String> index()Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.API name:
index
-
allowNoIndices
@Nullable public java.lang.Boolean 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
-
flatSettings
@Nullable public java.lang.Boolean flatSettings()If true, returns settings in flat format.API name:
flat_settings
-
includeDefaults
@Nullable public java.lang.Boolean includeDefaults()If true, return all default settings in the response.API name:
include_defaults
-
includeTypeName
@Nullable public java.lang.Boolean includeTypeName()If true, a mapping type is expected in the body of mappings.API name:
include_type_name
-
local
@Nullable public java.lang.Boolean 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
@Nullable public java.lang.String 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
-