com.gpudb.protocol

Class CreateJobRequest

java.lang.Object

com.gpudb.protocol.CreateJobRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createJob.

Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by GPUdb.getJob.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateJobRequest() Constructs a CreateJobRequest object with default parameters.
CreateJobRequest(String endpoint, String requestEncoding, ByteBuffer data, String dataStr, Map<String,String> options) Constructs a CreateJobRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and 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.
ByteBuffer	getData() Binary-encoded payload for the job to be run asynchronously.
String	getDataStr() JSON-encoded payload for the job to be run asynchronously.
String	getEndpoint() Indicates which endpoint to execute, e.g.
Map<String,String>	getOptions() Optional parameters.
String	getRequestEncoding() The encoding of the request payload for the job.
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.
CreateJobRequest	setData(ByteBuffer data) Binary-encoded payload for the job to be run asynchronously.
CreateJobRequest	setDataStr(String dataStr) JSON-encoded payload for the job to be run asynchronously.
CreateJobRequest	setEndpoint(String endpoint) Indicates which endpoint to execute, e.g.
CreateJobRequest	setOptions(Map<String,String> options) Optional parameters.
CreateJobRequest	setRequestEncoding(String requestEncoding) The encoding of the request payload for the job.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateJobRequest

public CreateJobRequest()

Constructs a CreateJobRequest object with default parameters.

CreateJobRequest

public CreateJobRequest(String endpoint,
                        String requestEncoding,
                        ByteBuffer data,
                        String dataStr,
                        Map<String,String> options)

Constructs a CreateJobRequest object with the specified parameters.

Parameters:

endpoint - Indicates which endpoint to execute, e.g. '/alter/table'.

requestEncoding - The encoding of the request payload for the job. Supported values:

• BINARY
• JSON
• SNAPPY

The default value is BINARY.

data - Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be BINARY or SNAPPY.

dataStr - JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be JSON.

options - Optional parameters.

• REMOVE_JOB_ON_COMPLETE: Supported values:
  • TRUE
  • FALSE
• JOB_TAG: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-'

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.

getEndpoint

public String getEndpoint()

Indicates which endpoint to execute, e.g. '/alter/table'.

Returns:

The current value of endpoint.

setEndpoint

public CreateJobRequest setEndpoint(String endpoint)

Indicates which endpoint to execute, e.g. '/alter/table'.

Parameters:

endpoint - The new value for endpoint.

Returns:

this to mimic the builder pattern.

getRequestEncoding

public String getRequestEncoding()

The encoding of the request payload for the job. Supported values:

• BINARY
• JSON
• SNAPPY

The default value is BINARY.

Returns:

The current value of requestEncoding.

setRequestEncoding

public CreateJobRequest setRequestEncoding(String requestEncoding)

The encoding of the request payload for the job. Supported values:

• BINARY
• JSON
• SNAPPY

The default value is BINARY.

Parameters:

requestEncoding - The new value for requestEncoding.

Returns:

this to mimic the builder pattern.

getData

public ByteBuffer getData()

Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be BINARY or SNAPPY.

Returns:

The current value of data.

setData

public CreateJobRequest setData(ByteBuffer data)

Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be BINARY or SNAPPY.

Parameters:

data - The new value for data.

Returns:

this to mimic the builder pattern.

getDataStr

public String getDataStr()

JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be JSON.

Returns:

The current value of dataStr.

setDataStr

public CreateJobRequest setDataStr(String dataStr)

JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be JSON.

Parameters:

dataStr - The new value for dataStr.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• REMOVE_JOB_ON_COMPLETE: Supported values:
  • TRUE
  • FALSE
• JOB_TAG: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-'

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• REMOVE_JOB_ON_COMPLETE: Supported values:
  • TRUE
  • FALSE
• JOB_TAG: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-'

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