Package org.elasticsearch.action.admin.indices.alias

Class IndicesAliasesRequest

org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<Request>
org.elasticsearch.action.support.master.AcknowledgedRequest<IndicesAliasesRequest>
org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequest
All Implemented Interfaces:
IndicesRequest, AckedRequest, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted, TaskAwareRequest
public class IndicesAliasesRequest extends AcknowledgedRequest<IndicesAliasesRequest> implements IndicesRequest, org.elasticsearch.common.xcontent.ToXContentObject
A request to add/remove aliases for one or more indices.

  • Field Details

    • PARSER

      public static final org.elasticsearch.common.xcontent.ObjectParser<> PARSER

  • Constructor Details

    • IndicesAliasesRequest

      public IndicesAliasesRequest​(StreamInput in) throws
      Throws:

    • IndicesAliasesRequest

      public IndicesAliasesRequest()

  • Method Details

    • origin

      public  origin()

    • origin

      public  origin)

    • addAliasAction

      public IndicesAliasesRequest addAliasAction​(IndicesAliasesRequest.AliasActions aliasAction)
      Add the action to this request and validate it.

    • getAliasActions

      public <IndicesAliasesRequest.AliasActions> getAliasActions()

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Overrides:
      writeTo in class AcknowledgedRequest<IndicesAliasesRequest>
      Throws:

    • 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

    • indices

      public [] indices()
      Description copied from interface: IndicesRequest
      Returns the array of indices that the action relates to
      Specified by:
      indices 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

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:

    • fromXContent

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