Package org.elasticsearch.client.tasks

Class GetTaskRequest

java.lang.Object
org.elasticsearch.client.tasks.GetTaskRequest
All Implemented Interfaces:
Validatable
public class GetTaskRequest
extends java.lang.Object
implements Validatable

  • Field Summary

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

    Constructors 
    Constructor Description
    GetTaskRequest​(java.lang.String nodeId, long taskId)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.String getNodeId()  
    long getTaskId()  
    org.elasticsearch.common.unit.TimeValue getTimeout()
    Timeout to wait for any async actions this request must take.
    boolean getWaitForCompletion()
    Should this request wait for all found tasks to complete?
    int hashCode()  
    GetTaskRequest setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)
    Timeout to wait for any async actions this request must take.
    GetTaskRequest setWaitForCompletion​(boolean waitForCompletion)
    Should this request wait for all found tasks to complete?
    java.util.Optional<ValidationException> validate()
    Perform validation.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GetTaskRequest

      public GetTaskRequest​(java.lang.String nodeId, long taskId)

  • Method Details

    • getNodeId

      public java.lang.String getNodeId()

    • getTaskId

      public long getTaskId()

    • getWaitForCompletion

      public boolean getWaitForCompletion()
      Should this request wait for all found tasks to complete?

    • setWaitForCompletion

      public GetTaskRequest setWaitForCompletion​(boolean waitForCompletion)
      Should this request wait for all found tasks to complete?

    • getTimeout

      public org.elasticsearch.common.unit.TimeValue getTimeout()
      Timeout to wait for any async actions this request must take. It must take anywhere from 0 to 2.

    • setTimeout

      public GetTaskRequest setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)
      Timeout to wait for any async actions this request must take.

    • validate

      public java.util.Optional<ValidationException> validate()
      Description copied from interface: Validatable
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.

    • hashCode

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

    • equals

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