Package org.opensearch.action.search

Class SearchScrollRequest

java.lang.Object
org.opensearch.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.action.search.SearchScrollRequest
All Implemented Interfaces:
Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject, TaskAwareRequest
public class SearchScrollRequest
extends ActionRequest
implements org.opensearch.common.xcontent.ToXContentObject

  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Overrides:
      writeTo in class ActionRequest
      Throws:
      java.io.IOException

    • validate

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

    • scrollId

      public java.lang.String scrollId()
      The scroll id used to scroll the search.

    • scrollId

      public SearchScrollRequest scrollId​(java.lang.String scrollId)

    • parseScrollId

      public ParsedScrollId parseScrollId()

    • scroll

      public Scroll scroll()
      If set, will enable scrolling of the search request.

    • scroll

      public SearchScrollRequest scroll​(Scroll scroll)
      If set, will enable scrolling of the search request.

    • scroll

      public SearchScrollRequest scroll​(org.opensearch.common.unit.TimeValue keepAlive)
      If set, will enable scrolling of the search request for the specified timeout.

    • scroll

      public SearchScrollRequest scroll​(java.lang.String keepAlive)
      If set, will enable scrolling of the search request for the specified timeout.

    • createTask

      public Task createTask​(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,​java.lang.String> 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

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • getDescription

      public java.lang.String 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

    • toXContent

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

    • fromXContent

      public void fromXContent​(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Parse a search scroll request from a request body provided through the REST layer. Values that are already be set and are also found while parsing will be overridden.
      Throws:
      java.io.IOException