Package org.opensearch.client.opensearch.indices

Class GetIndicesSettingsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>

org.opensearch.client.opensearch.indices.GetIndicesSettingsRequest.Builder

All Implemented Interfaces:

CopyableBuilder<GetIndicesSettingsRequest.Builder,GetIndicesSettingsRequest>, MutableBuilder<GetIndicesSettingsRequest.Builder,GetIndicesSettingsRequest>, ObjectBuilder<GetIndicesSettingsRequest>

Enclosing class:

GetIndicesSettingsRequest

public static class GetIndicesSettingsRequest.Builder
extends RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>
implements CopyableBuilder<GetIndicesSettingsRequest.Builder,GetIndicesSettingsRequest>

Builder for GetIndicesSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetIndicesSettingsRequest.Builder	allowNoIndices(Boolean value)	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
GetIndicesSettingsRequest	build()	Builds a GetIndicesSettingsRequest.
final GetIndicesSettingsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final GetIndicesSettingsRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
GetIndicesSettingsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetIndicesSettingsRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final GetIndicesSettingsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final GetIndicesSettingsRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetIndicesSettingsRequest.Builder	ignoreUnavailable(Boolean value)	If false, the request returns an error if it targets a missing or closed index.
final GetIndicesSettingsRequest.Builder	includeDefaults(Boolean value)	If true, return all default settings in the response.
final GetIndicesSettingsRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indexes, and aliases used to limit the request.
final GetIndicesSettingsRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indexes, and aliases used to limit the request.
final GetIndicesSettingsRequest.Builder	local(Boolean value)	If true, the request retrieves information from the local node only.
final GetIndicesSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetIndicesSettingsRequest.Builder	masterTimeout(Time value)	Deprecated.
final GetIndicesSettingsRequest.Builder	name(String value, String... values)	Comma-separated list or wildcard expression of settings to retrieve.
final GetIndicesSettingsRequest.Builder	name(List<String> list)	Comma-separated list or wildcard expression of settings to retrieve.
protected GetIndicesSettingsRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetIndicesSettingsRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetIndicesSettingsRequest.Builder,GetIndicesSettingsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetIndicesSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>

allowNoIndices

@Nonnull
public final GetIndicesSettingsRequest.Builder allowNoIndices(@Nullable
 Boolean value)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. 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

clusterManagerTimeout

@Nonnull
public final GetIndicesSettingsRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final GetIndicesSettingsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

expandWildcards

@Nonnull
public final GetIndicesSettingsRequest.Builder expandWildcards(List<ExpandWildcard> list)

Type of index that wildcard patterns 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 to expandWildcards.

expandWildcards

@Nonnull
public final GetIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Type of index that wildcard patterns 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

@Nonnull
public final GetIndicesSettingsRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

ignoreUnavailable

@Nonnull
public final GetIndicesSettingsRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

includeDefaults

@Nonnull
public final GetIndicesSettingsRequest.Builder includeDefaults(@Nullable
 Boolean value)

If true, return all default settings in the response.

API name: include_defaults

index

@Nonnull
public final GetIndicesSettingsRequest.Builder index(List<String> list)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final GetIndicesSettingsRequest.Builder index(String value,
 String... values)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

local

@Nonnull
public final GetIndicesSettingsRequest.Builder local(@Nullable
 Boolean value)

If true, the request retrieves information from the local node only. If false, information is retrieved from the cluster-manager node.

API name: local

masterTimeout

@Deprecated
@Nonnull
public final GetIndicesSettingsRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final GetIndicesSettingsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

@Nonnull
public final GetIndicesSettingsRequest.Builder name(List<String> list)

Comma-separated list or wildcard expression of settings to retrieve.

API name: name

Adds all elements of list to name.

name

@Nonnull
public final GetIndicesSettingsRequest.Builder name(String value,
 String... values)

Comma-separated list or wildcard expression of settings to retrieve.

API name: name

Adds one or more values to name.

build

@Nonnull
public GetIndicesSettingsRequest build()

Builds a GetIndicesSettingsRequest.

Specified by:

build in interface ObjectBuilder<GetIndicesSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.