Class GetJobRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

    public class GetJobRequest
    extends Object
    implements org.apache.avro.generic.IndexedRecord
    A set of parameters for GPUdb.getJob.

    Get the status and result of asynchronously running job. See the GPUdb.createJob for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

    • Constructor Detail

      • GetJobRequest

        public GetJobRequest()
        Constructs a GetJobRequest object with default parameters.
      • GetJobRequest

        public GetJobRequest​(long jobId,
                             Map<String,​String> options)
        Constructs a GetJobRequest object with the specified parameters.
        Parameters:
        jobId - A unique identifier for the job whose status and result is to be fetched.
        options - Optional parameters.
        • JOB_TAG: Job tag returned in call to create the job
        The default value is an empty Map.
    • Method Detail

      • getClassSchema

        public static org.apache.avro.Schema getClassSchema()
        This method supports the Avro framework and is not intended to be called directly by the user.
        Returns:
        The schema for the class.
      • getJobId

        public long getJobId()
        A unique identifier for the job whose status and result is to be fetched.
        Returns:
        The current value of jobId.
      • setJobId

        public GetJobRequest setJobId​(long jobId)
        A unique identifier for the job whose status and result is to be fetched.
        Parameters:
        jobId - The new value for jobId.
        Returns:
        this to mimic the builder pattern.
      • getOptions

        public Map<String,​String> getOptions()
        Optional parameters.
        • JOB_TAG: Job tag returned in call to create the job
        The default value is an empty Map.
        Returns:
        The current value of options.
      • setOptions

        public GetJobRequest setOptions​(Map<String,​String> options)
        Optional parameters.
        • JOB_TAG: Job tag returned in call to create the job
        The default value is an empty Map.
        Parameters:
        options - The new value for options.
        Returns:
        this to mimic the builder pattern.
      • getSchema

        public org.apache.avro.Schema getSchema()
        This method supports the Avro framework and is not intended to be called directly by the user.
        Specified by:
        getSchema in interface org.apache.avro.generic.GenericContainer
        Returns:
        The schema object describing this class.
      • get

        public Object get​(int index)
        This method supports the Avro framework and is not intended to be called directly by the user.
        Specified by:
        get in interface org.apache.avro.generic.IndexedRecord
        Parameters:
        index - the position of the field to get
        Returns:
        value of the field with the given index.
        Throws:
        IndexOutOfBoundsException
      • put

        public void put​(int index,
                        Object value)
        This method supports the Avro framework and is not intended to be called directly by the user.
        Specified by:
        put in interface org.apache.avro.generic.IndexedRecord
        Parameters:
        index - the position of the field to set
        value - the value to set
        Throws:
        IndexOutOfBoundsException
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object