Package org.elasticsearch.action.search

Class OpenPointInTimeRequest

org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.search.OpenPointInTimeRequest
All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest
public final class OpenPointInTimeRequest extends ActionRequest implements IndicesRequest.Replaceable

  • Field Details

    • DEFAULT_INDICES_OPTIONS

      public static final IndicesOptions DEFAULT_INDICES_OPTIONS

  • Constructor Details

    • OpenPointInTimeRequest

      public OpenPointInTimeRequest​(... indices)

    • OpenPointInTimeRequest

      public OpenPointInTimeRequest​(StreamInput in) throws
      Throws:

  • Method Details

    • 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 ActionRequest
      Throws:

    • validate

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

    • indices

      public [] indices()
      Description copied from interface: IndicesRequest
      Returns the array of indices that the action relates to
      Specified by:
      indices in interface IndicesRequest

    • indices

      public ... indices)
      Description copied from interface: IndicesRequest.Replaceable
      Sets the indices that the action relates to.
      Specified by:
      indices in interface IndicesRequest.Replaceable

    • 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

    • indicesOptions

      public OpenPointInTimeRequest indicesOptions​(IndicesOptions indicesOptions)

    • keepAlive

      public org.elasticsearch.core.TimeValue keepAlive()

    • keepAlive

      public OpenPointInTimeRequest keepAlive​(org.elasticsearch.core.TimeValue keepAlive)
      Set keep alive for the point in time

    • routing

      public  routing()

    • routing

      public  routing)

    • preference

      public  preference()

    • preference

      public  preference)

    • allowsRemoteIndices

      public boolean allowsRemoteIndices()
      Description copied from interface: IndicesRequest
      Determines whether the request can contain indices on a remote cluster.
      Specified by:
      allowsRemoteIndices 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

    • getDescription

      public  getDescription()
      Description copied from interface: TaskAwareRequest
      Returns optional description of the request to be displayed by the task manager
      Specified by:
      getDescription in interface TaskAwareRequest

    • createTask

      public Task createTask​(long id,  type,  action, TaskId parentTaskId, <,​> headers)
      Description copied from interface: TaskAwareRequest
      Returns the task object that should be used to keep track of the processing of the request.
      Specified by:
      createTask in interface TaskAwareRequest