Package org.opensearch.client.opensearch.indices

Class GetIndicesSettingsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetIndicesSettingsRequest

public class GetIndicesSettingsRequest
extends RequestBase

Returns settings for one or more indices.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<GetIndicesSettingsRequest,GetIndicesSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_settings".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
java.util.List<ExpandWildcard>	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 cluster-manager node (default: false)
Time	masterTimeout()	Deprecated.
java.util.List<java.lang.String>	name()	The name of the settings that should be included
static GetIndicesSettingsRequest	of(java.util.function.Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<GetIndicesSettingsRequest,GetIndicesSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_settings".

Method Detail

of

public static GetIndicesSettingsRequest of(java.util.function.Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)

allowNoIndices

@Nullable
public final 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

public final java.util.List<ExpandWildcard> expandWildcards()

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

API name: expand_wildcards

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

includeDefaults

@Nullable
public final java.lang.Boolean includeDefaults()

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

API name: include_defaults

index

public final 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

local

@Nullable
public final java.lang.Boolean local()

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

API name: local

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

name

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

The name of the settings that should be included

API name: name