Skip to main content
Package com.gpudb.protocol

​
Class AdminAlterJobsRequest

java.lang.Object
com.gpudb.protocol.AdminAlterJobsRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class AdminAlterJobsRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.adminAlterJobs.

Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.

  • ​
    Constructor Details

    • ​
      AdminAlterJobsRequest

      public AdminAlterJobsRequest()
      Constructs an AdminAlterJobsRequest object with default parameters.

    • ​
      AdminAlterJobsRequest

      public AdminAlterJobsRequest(List<Long> jobIds, String action, Map<String,String> options)
      Constructs an AdminAlterJobsRequest object with the specified parameters.
      Parameters:
      jobIds - Jobs to be modified.
      action - Action to be performed on the jobs specified by job_ids. Supported values:
      options - Optional parameters.
      • JOB_TAG: Job tag returned in call to create the job.
      The default value is an empty Map.

  • ​
    Method Details

    • ​
      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.

    • ​
      getJobIds

      public List<Long> getJobIds()
      Jobs to be modified.
      Returns:
      The current value of jobIds.

    • ​
      setJobIds

      public AdminAlterJobsRequest setJobIds(List<Long> jobIds)
      Jobs to be modified.
      Parameters:
      jobIds - The new value for jobIds.
      Returns:
      this to mimic the builder pattern.

    • ​
      getAction

      public String getAction()
      Action to be performed on the jobs specified by job_ids. Supported values:
      Returns:
      The current value of action.

    • ​
      setAction

      public AdminAlterJobsRequest setAction(String action)
      Action to be performed on the jobs specified by job_ids. Supported values:
      Parameters:
      action - The new value for action.
      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 AdminAlterJobsRequest 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

    • ​
      equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • ​
      toString

      public String toString()
      Overrides:
      toString in class Object

    • ​
      hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object