Package org.opensearch.action.admin.indices.settings.get

Class GetSettingsRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<GetSettingsRequest>

org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest<GetSettingsRequest>

org.opensearch.action.admin.indices.settings.get.GetSettingsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

@PublicApi(since="1.0.0")
public class GetSettingsRequest
extends ClusterManagerNodeReadRequest<GetSettingsRequest>
implements IndicesRequest.Replaceable

Transport request for getting index segments

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest

local

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
GetSettingsRequest()
GetSettingsRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
boolean	humanReadable()
GetSettingsRequest	humanReadable(boolean humanReadable)
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
boolean	includeDefaults()
GetSettingsRequest	includeDefaults(boolean includeDefaults)	When include_defaults is set, return default values which are normally suppressed.
String[]	indices()	Returns the array of indices that the action relates to
GetSettingsRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
GetSettingsRequest	indicesOptions(IndicesOptions indicesOptions)
String[]	names()
GetSettingsRequest	names(String... names)
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest

local, local

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, clusterManagerNodeTimeout, clusterManagerNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

GetSettingsRequest

public GetSettingsRequest()

GetSettingsRequest

public GetSettingsRequest(org.opensearch.core.common.io.stream.StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

indices

public GetSettingsRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public GetSettingsRequest indicesOptions(IndicesOptions indicesOptions)

includeDefaults

public GetSettingsRequest includeDefaults(boolean includeDefaults)

When include_defaults is set, return default values which are normally suppressed. This flag is specific to the rest client.

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ClusterManagerNodeReadRequest<GetSettingsRequest>

Throws:

IOException

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

names

public String[] names()

names

public GetSettingsRequest names(String... names)

humanReadable

public boolean humanReadable()

humanReadable

public GetSettingsRequest humanReadable(boolean humanReadable)

includeDefaults

public boolean includeDefaults()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object