Class ClientEndpoint

  • Direct Known Subclasses:
    NemoPipelineResult

    public abstract class ClientEndpoint
    extends java.lang.Object
    A request endpoint in client side of a plan.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Enum getPlanState()
      Get the current state of the running plan.
      java.lang.Enum waitUntilJobFinish()
      Wait for this job to be finished and return the final state.
      java.lang.Enum waitUntilJobFinish​(long timeout, java.util.concurrent.TimeUnit unit)
      Wait for this job to be finished (complete or failed) and return the final state.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ClientEndpoint

        public ClientEndpoint​(StateTranslator stateTranslator)
        Constructor.
        Parameters:
        stateTranslator - translator to translate between the state of plan and corresponding.
    • Method Detail

      • getPlanState

        public final java.lang.Enum getPlanState()
        Get the current state of the running plan.
        Returns:
        the current state of the running plan.
      • waitUntilJobFinish

        public final java.lang.Enum waitUntilJobFinish​(long timeout,
                                                       java.util.concurrent.TimeUnit unit)
        Wait for this job to be finished (complete or failed) and return the final state. It wait for at most the given time.
        Parameters:
        timeout - of waiting.
        unit - of the timeout.
        Returns:
        the final state of this job.
      • waitUntilJobFinish

        public final java.lang.Enum waitUntilJobFinish()
        Wait for this job to be finished and return the final state.
        Returns:
        the final state of this job.