Class SearchScrollRequest

    • Constructor Detail

      • SearchScrollRequest

        public SearchScrollRequest()
      • SearchScrollRequest

        public SearchScrollRequest​(java.lang.String scrollId)
    • Method Detail

      • scrollId

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

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

        public SearchScrollRequest scroll​(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. A request can override this method and return null to avoid being tracked by the task manager.
        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
      • fromXContent

        public void fromXContent​(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