GetJobResponse (Kinetica Java API 7.0.19.0 API)

java.lang.Object
- com.gpudb.protocol.GetJobResponse

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class GetJobResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of results returned by GPUdb.getJob(GetJobRequest).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GetJobResponse.JobStatus` Status of the submitted job.
`static class`	`GetJobResponse.ResponseEncoding` The encoding of the job result (contained in `jobResponse` or `jobResponseStr`.
`static class`	`GetJobResponse.StatusMap` Map of various status strings for the executed job.

Constructor Summary

Constructors
Constructor and Description

GetJobResponse()
Constructs a GetJobResponse object with default parameters.

Constructors
Constructor and Description
`GetJobResponse()` Constructs a GetJobResponse object with default parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`String`	`getEndpoint()`
`Map<String,String>`	`getInfo()`
`ByteBuffer`	`getJobResponse()`
`String`	`getJobResponseStr()`
`String`	`getJobStatus()`
`int`	`getProgress()`
`String`	`getResponseEncoding()`
`boolean`	`getRunning()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,String>`	`getStatusMap()`
`boolean`	`getSuccessful()`
`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.
`GetJobResponse`	`setEndpoint(String endpoint)`
`GetJobResponse`	`setInfo(Map<String,String> info)`
`GetJobResponse`	`setJobResponse(ByteBuffer jobResponse)`
`GetJobResponse`	`setJobResponseStr(String jobResponseStr)`
`GetJobResponse`	`setJobStatus(String jobStatus)`
`GetJobResponse`	`setProgress(int progress)`
`GetJobResponse`	`setResponseEncoding(String responseEncoding)`
`GetJobResponse`	`setRunning(boolean running)`
`GetJobResponse`	`setStatusMap(Map<String,String> statusMap)`
`GetJobResponse`	`setSuccessful(boolean successful)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetJobResponse
```
public GetJobResponse()
```
    Constructs a GetJobResponse object with default parameters.
- 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()
```
    Returns:
    
    The endpoint which is being executed asynchronously. E.g. '/alter/table'.
  - setEndpoint
```
public GetJobResponse setEndpoint(String endpoint)
```
    Parameters:
    
    endpoint - The endpoint which is being executed asynchronously. E.g. '/alter/table'.
    
    Returns:
    
    this to mimic the builder pattern.
  - getJobStatus
```
public String getJobStatus()
```
    Returns:
    Status of the submitted job. Supported values:
    
    RUNNING: The job is currently executing.
    DONE: The job execution has successfully completed and the response is included in the jobResponse or jobResponseStr field
    ERROR: The job was attempted, but an error was encountered. The statusMap contains the details of the error in error_message
    CANCELLED: Job cancellation was requested while the execution was in progress.
  - setJobStatus
```
public GetJobResponse setJobStatus(String jobStatus)
```
    Parameters:
    jobStatus - Status of the submitted job. Supported values:
    
    RUNNING: The job is currently executing.
    DONE: The job execution has successfully completed and the response is included in the jobResponse or jobResponseStr field
    ERROR: The job was attempted, but an error was encountered. The statusMap contains the details of the error in error_message
    CANCELLED: Job cancellation was requested while the execution was in progress.
    Returns:
    
    this to mimic the builder pattern.
  - getRunning
```
public boolean getRunning()
```
    Returns:
    
    True if the end point is still executing.
  - setRunning
```
public GetJobResponse setRunning(boolean running)
```
    Parameters:
    
    running - True if the end point is still executing.
    
    Returns:
    
    this to mimic the builder pattern.
  - getProgress
```
public int getProgress()
```
    Returns:
    
    Approximate percentage of the job completed.
  - setProgress
```
public GetJobResponse setProgress(int progress)
```
    Parameters:
    
    progress - Approximate percentage of the job completed.
    
    Returns:
    
    this to mimic the builder pattern.
  - getSuccessful
```
public boolean getSuccessful()
```
    Returns:
    
    True if the job execution completed and no errors were encountered.
  - setSuccessful
```
public GetJobResponse setSuccessful(boolean successful)
```
    Parameters:
    
    successful - True if the job execution completed and no errors were encountered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getResponseEncoding
```
public String getResponseEncoding()
```
    Returns:
    The encoding of the job result (contained in jobResponse or jobResponseStr. Supported values:
    
    BINARY: The job result is binary-encoded. It is contained in jobResponse.
    JSON: The job result is json-encoded. It is contained in jobResponseStr.
  - setResponseEncoding
```
public GetJobResponse setResponseEncoding(String responseEncoding)
```
    Parameters:
    responseEncoding - The encoding of the job result (contained in jobResponse or jobResponseStr. Supported values:
    
    BINARY: The job result is binary-encoded. It is contained in jobResponse.
    JSON: The job result is json-encoded. It is contained in jobResponseStr.
    Returns:
    
    this to mimic the builder pattern.
  - getJobResponse
```
public ByteBuffer getJobResponse()
```
    Returns:
    
    The binary-encoded response of the job. This field is populated only when the job has completed and responseEncoding is binary
  - setJobResponse
```
public GetJobResponse setJobResponse(ByteBuffer jobResponse)
```
    Parameters:
    
    jobResponse - The binary-encoded response of the job. This field is populated only when the job has completed and responseEncoding is binary
    
    Returns:
    
    this to mimic the builder pattern.
  - getJobResponseStr
```
public String getJobResponseStr()
```
    Returns:
    
    The json-encoded response of the job. This field is populated only when the job has completed and responseEncoding is json
  - setJobResponseStr
```
public GetJobResponse setJobResponseStr(String jobResponseStr)
```
    Parameters:
    
    jobResponseStr - The json-encoded response of the job. This field is populated only when the job has completed and responseEncoding is json
    
    Returns:
    
    this to mimic the builder pattern.
  - getStatusMap
```
public Map<String,String> getStatusMap()
```
    Returns:
    Map of various status strings for the executed job.
    
    ERROR_MESSAGE: Explains what error occurred while running the job asynchronously. This entry only exists when the job status is ERROR.
  - setStatusMap
```
public GetJobResponse setStatusMap(Map<String,String> statusMap)
```
    Parameters:
    statusMap - Map of various status strings for the executed job.
    
    ERROR_MESSAGE: Explains what error occurred while running the job asynchronously. This entry only exists when the job status is ERROR.
    Returns:
    
    this to mimic the builder pattern.
  - getInfo
```
public Map<String,String> getInfo()
```
    Returns:
    
    Additional information.
  - setInfo
```
public GetJobResponse setInfo(Map<String,String> info)
```
    Parameters:
    
    info - Additional information.
    
    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

Class GetJobResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetJobResponse

Method Detail

getClassSchema

getEndpoint

setEndpoint

getJobStatus

setJobStatus

getRunning

setRunning

getProgress

setProgress

getSuccessful

setSuccessful

getResponseEncoding

setResponseEncoding

getJobResponse

setJobResponse

getJobResponseStr

setJobResponseStr

getStatusMap

setStatusMap

getInfo

setInfo

getSchema

get

put

equals

toString

hashCode