Package com.gpudb.protocol

Class AdminShowJobsRequest

java.lang.Object

com.gpudb.protocol.AdminShowJobsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AdminShowJobsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.adminShowJobs.

Get a list of the current jobs in GPUdb.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminShowJobsRequest.Options	A set of string constants for the AdminShowJobsRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
AdminShowJobsRequest()	Constructs an AdminShowJobsRequest object with default parameters.
AdminShowJobsRequest(Map<String,String> options)	Constructs an AdminShowJobsRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	get(int index)	This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()	Optional parameters.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value)	This method supports the Avro framework and is not intended to be called directly by the user.
AdminShowJobsRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminShowJobsRequest

public AdminShowJobsRequest()

Constructs an AdminShowJobsRequest object with default parameters.

AdminShowJobsRequest

public AdminShowJobsRequest(Map<String,String> options)

Constructs an AdminShowJobsRequest object with the specified parameters.

Parameters:

options - Optional parameters.

• SHOW_ASYNC_JOBS: If TRUE, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_WORKER_INFO: If TRUE, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
  • TRUE
  • FALSE

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.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• SHOW_ASYNC_JOBS: If TRUE, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_WORKER_INFO: If TRUE, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
  • TRUE
  • FALSE

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public AdminShowJobsRequest setOptions(Map<String,String> options)

Optional parameters.

• SHOW_ASYNC_JOBS: If TRUE, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_WORKER_INFO: If TRUE, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
  • TRUE
  • FALSE

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