Package co.elastic.clients.elasticsearch.indices

Class GetSettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetSettingsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class GetSettingsRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSettingsRequest.Builder	Builder for GetSettingsRequest.

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<GetSettingsRequest,GetSettingsResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.get_settings".

Constructor Summary

Constructors

Constructor	Description
GetSettingsRequest(GetSettingsRequest.Builder builder)
GetSettingsRequest(java.util.function.Function<GetSettingsRequest.Builder,GetSettingsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.util.List<ExpandWildcardOptions>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	flatSettings()	Return settings in flat format (default: false)
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.lang.Boolean	includeDefaults()	Whether to return all default setting for each of the indices.
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
java.lang.Boolean	local()	Return local information, do not retrieve the state from master node (default: false)
java.lang.String	masterTimeout()	Specify timeout for connection to master
java.util.List<java.lang.String>	name()	The name of the settings that should be included

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENDPOINT

public static final Endpoint<GetSettingsRequest,GetSettingsResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.get_settings".

Constructor Details

GetSettingsRequest

public GetSettingsRequest(GetSettingsRequest.Builder builder)

GetSettingsRequest

public GetSettingsRequest(java.util.function.Function<GetSettingsRequest.Builder,GetSettingsRequest.Builder> fn)

Method Details

index

@Nullable
public java.util.List<java.lang.String> index()

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

name

@Nullable
public java.util.List<java.lang.String> name()

The name of the settings that should be included

API name: name

allowNoIndices

@Nullable
public java.lang.Boolean 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

@Nullable
public java.util.List<ExpandWildcardOptions> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

flatSettings

@Nullable
public java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

includeDefaults

@Nullable
public java.lang.Boolean includeDefaults()

Whether to return all default setting for each of the indices.

API name: include_defaults

local

@Nullable
public java.lang.Boolean local()

Return local information, do not retrieve the state from master node (default: false)

API name: local

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Specify timeout for connection to master

API name: master_timeout