Package alluxio.client.job

Interface JobMasterClient

  • All Superinterfaces:
    java.lang.AutoCloseable, alluxio.Client, java.io.Closeable
    All Known Implementing Classes:
    RetryHandlingJobMasterClient
    public interface JobMasterClient
extends alluxio.Client
    Interface for job service clients to communicate with the job master.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void cancel​(long id)
      Cancels the given job.
      java.util.List<alluxio.job.wire.JobWorkerHealth> getAllWorkerHealth()
      Gets all worker health.
      alluxio.job.wire.Status getCmdStatus​(long id)
      Gets the status of the given command jobControlId.
      alluxio.job.wire.CmdStatusBlock getCmdStatusDetailed​(long id)
      Gets the detailed status of the given command jobControlId.
      alluxio.job.wire.JobServiceSummary getJobServiceSummary()
      Gets the job service summary.
      alluxio.job.wire.JobInfo getJobStatus​(long id)
      Gets the status of the given job id.
      alluxio.job.wire.JobInfo getJobStatusDetailed​(long id)
      Gets detailed status of the given job id.
      default java.util.List<java.lang.Long> list()  
      java.util.List<java.lang.Long> list​(alluxio.grpc.ListAllPOptions option)  
      java.util.List<alluxio.job.wire.JobInfo> listDetailed()  
      long run​(alluxio.job.JobConfig jobConfig)
      Starts a plan based on the given configuration.
      long submit​(alluxio.job.CmdConfig cmdConfig)
      Submit a Cmd Job based on the given configuration.

      • Methods inherited from interface alluxio.Client

        connect, disconnect, getConfAddress, getRemoteHostName, getRemoteSockAddress, isClosed, isConnected

      • Methods inherited from interface java.io.Closeable

        close

    • Method Detail

      • cancel

        void cancel​(long id)
     throws java.io.IOException
        Cancels the given job.
        Parameters:
        id - the job id
        Throws:
        java.io.IOException

      • getJobStatus

        alluxio.job.wire.JobInfo getJobStatus​(long id)
                               throws java.io.IOException
        Gets the status of the given job id.
        Parameters:
        id - the job id
        Returns:
        the job information
        Throws:
        java.io.IOException

      • getJobStatusDetailed

        alluxio.job.wire.JobInfo getJobStatusDetailed​(long id)
                                       throws java.io.IOException
        Gets detailed status of the given job id.
        Parameters:
        id - the job id
        Returns:
        the detailed job information
        Throws:
        java.io.IOException

      • getJobServiceSummary

        alluxio.job.wire.JobServiceSummary getJobServiceSummary()
                                                 throws java.io.IOException
        Gets the job service summary.
        Returns:
        the job service summary
        Throws:
        java.io.IOException

      • list

        default java.util.List<java.lang.Long> list()
                                     throws java.io.IOException
        Returns:
        list all job ids
        Throws:
        java.io.IOException

      • list

        java.util.List<java.lang.Long> list​(alluxio.grpc.ListAllPOptions option)
                             throws java.io.IOException
        Parameters:
        option - list options
        Returns:
        the list of ids of all jobs
        Throws:
        java.io.IOException

      • listDetailed

        java.util.List<alluxio.job.wire.JobInfo> listDetailed()
                                               throws java.io.IOException
        Returns:
        the list of all jobInfos
        Throws:
        java.io.IOException

      • run

        long run​(alluxio.job.JobConfig jobConfig)
  throws java.io.IOException
        Starts a plan based on the given configuration.
        Parameters:
        jobConfig - the job configuration
        Returns:
        the plan id
        Throws:
        java.io.IOException

      • submit

        long submit​(alluxio.job.CmdConfig cmdConfig)
     throws java.io.IOException
        Submit a Cmd Job based on the given configuration.
        Parameters:
        cmdConfig - the Cmd job config
        Returns:
        the jobControlId
        Throws:
        java.io.IOException

      • getCmdStatus

        alluxio.job.wire.Status getCmdStatus​(long id)
                              throws java.io.IOException
        Gets the status of the given command jobControlId.
        Parameters:
        id - the jobControl id
        Returns:
        the command status
        Throws:
        java.io.IOException

      • getCmdStatusDetailed

        alluxio.job.wire.CmdStatusBlock getCmdStatusDetailed​(long id)
                                              throws java.io.IOException
        Gets the detailed status of the given command jobControlId.
        Parameters:
        id - the jobControl id
        Returns:
        the detailed command status information
        Throws:
        java.io.IOException

      • getAllWorkerHealth

        java.util.List<alluxio.job.wire.JobWorkerHealth> getAllWorkerHealth()
                                                             throws java.io.IOException
        Gets all worker health.
        Returns:
        list of all worker health information
        Throws:
        java.io.IOException