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 -
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices(Boolean value) Iffalse, the request returns an error if any wildcard expression, index alias, or_allvalue targets only missing or closed indexes.build()Builds aGetIndicesSettingsRequest.Operation timeout for connection to cluster-manager node.clusterManagerTimeout(Time value) Operation timeout for connection to cluster-manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.expandWildcards(List<ExpandWildcard> list) Type of index that wildcard patterns can match.expandWildcards(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.flatSettings(Boolean value) Iftrue, returns settings in flat format.ignoreUnavailable(Boolean value) Iffalse, the request returns an error if it targets a missing or closed index.includeDefaults(Boolean value) Iftrue, return all default settings in the response.Comma-separated list of data streams, indexes, and aliases used to limit the request.Comma-separated list of data streams, indexes, and aliases used to limit the request.Iftrue, the request retrieves information from the local node only.Deprecated.masterTimeout(Time value) Deprecated.Comma-separated list or wildcard expression of settings to retrieve.Comma-separated list or wildcard expression of settings to retrieve.protected GetIndicesSettingsRequest.Builderself()Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder
errorTrace, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<GetIndicesSettingsRequest.Builder,GetIndicesSettingsRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>
-
allowNoIndices
Iffalse, the request returns an error if any wildcard expression, index alias, or_allvalue targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targetingfoo*,bar*returns an error if an index starts with foo but no index starts withbar.API name:
allow_no_indices -
clusterManagerTimeout
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
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 asopen,hidden.API name:
expand_wildcardsAdds all elements of
listtoexpandWildcards. -
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 asopen,hidden.API name:
expand_wildcardsAdds one or more values to
expandWildcards. -
flatSettings
Iftrue, returns settings in flat format.API name:
flat_settings -
includeDefaults
Iftrue, return all default settings in the response.API name:
include_defaults -
index
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:
indexAdds all elements of
listtoindex. -
index
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:
indexAdds one or more values to
index. -
local
Iftrue, the request retrieves information from the local node only. Iffalse, 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
Comma-separated list or wildcard expression of settings to retrieve.API name:
nameAdds all elements of
listtoname. -
name
Comma-separated list or wildcard expression of settings to retrieve.API name:
nameAdds one or more values to
name. -
build
Builds aGetIndicesSettingsRequest.- Specified by:
buildin interfaceObjectBuilder<GetIndicesSettingsRequest>- Throws:
NullPointerException- if some of the required fields are null.
-