Package org.apache.gravitino.job

Interface JobHandle

All Known Implementing Classes:
GenericJobHandle
public interface JobHandle
JobHandle is an interface that is returned by the job submission, which provides methods to get the job name, job ID, job status, and to add listeners for jobs.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    JobHandle.Status
    The status of the job.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_ID_PREFIX
    The prefix for job IDs, every job ID returned from Gravitino will be like job-uuid

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    jobId()
    Get the unique identifier of the job.
    JobHandle.Status
    jobStatus()
    Get the current status of the job.
    String
    jobTemplateName()
    Get the name of the job template.

  • Field Details

    • JOB_ID_PREFIX

      static final String JOB_ID_PREFIX
      The prefix for job IDs, every job ID returned from Gravitino will be like job-uuid
      See Also:

  • Method Details

    • jobTemplateName

      String jobTemplateName()
      Get the name of the job template.
      Returns:
      the name of the job template

    • jobId

      String jobId()
      Get the unique identifier of the job.
      Returns:
      the job ID

    • jobStatus

      JobHandle.Status jobStatus()
      Get the current status of the job.
      Returns:
      the status of the job