Package org.opensearch.action.admin.indices.alias

Class IndicesAliasesRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

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

org.opensearch.action.support.master.MasterNodeRequest<Request>

org.opensearch.action.support.master.AcknowledgedRequest<IndicesAliasesRequest>

org.opensearch.action.admin.indices.alias.IndicesAliasesRequest

All Implemented Interfaces:

AckedRequest, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject, TaskAwareRequest

public class IndicesAliasesRequest
extends AcknowledgedRequest<IndicesAliasesRequest>
implements org.opensearch.common.xcontent.ToXContentObject

A request to add/remove aliases for one or more indices.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndicesAliasesRequest.AliasActions	Request to take one or more actions on one or more indexes and alias combinations.

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.opensearch.common.xcontent.ObjectParser<IndicesAliasesRequest,Void>	PARSER

Fields inherited from class org.opensearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

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

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IndicesAliasesRequest()
IndicesAliasesRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
IndicesAliasesRequest	addAliasAction(IndicesAliasesRequest.AliasActions aliasAction)	Add the action to this request and validate it.
static IndicesAliasesRequest	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
List<IndicesAliasesRequest.AliasActions>	getAliasActions()
IndicesOptions	indicesOptions()
String	origin()
IndicesAliasesRequest	origin(String origin)
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.master.AcknowledgedRequest

ackTimeout, timeout, timeout, timeout

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.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.cluster.ack.AckedRequest

clusterManagerNodeTimeout, masterNodeTimeout

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final org.opensearch.common.xcontent.ObjectParser<IndicesAliasesRequest,Void> PARSER

Constructor Details

IndicesAliasesRequest

public IndicesAliasesRequest(StreamInput in)
                      throws IOException

Throws:

IOException

IndicesAliasesRequest

public IndicesAliasesRequest()

Method Details

origin

public String origin()

origin

public IndicesAliasesRequest origin(String origin)

addAliasAction

public IndicesAliasesRequest addAliasAction(IndicesAliasesRequest.AliasActions aliasAction)

Add the action to this request and validate it.

getAliasActions

public List<IndicesAliasesRequest.AliasActions> getAliasActions()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<IndicesAliasesRequest>

Throws:

IOException

indicesOptions

public IndicesOptions indicesOptions()

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

fromXContent

public static IndicesAliasesRequest fromXContent(org.opensearch.common.xcontent.XContentParser parser)