A set of results returned by Kinetica.getJob. More…
Inheritance diagram for kinetica.GetJobResponse:
[legend]
Collaboration diagram for kinetica.GetJobResponse:
[legend]
Classes | |
| struct | JobStatus |
| A set of string constants for the parameter GetJobResponse.job_status. More… | |
| struct | ResponseEncoding |
| A set of string constants for the parameter GetJobResponse.response_encoding. More… | |
| struct | StatusMap |
| A set of string constants for the parameter GetJobResponse.status_map. More… | |
Properties | |
| string | endpoint [get, set] |
| The endpoint which is being executed asynchronously. | |
| string | job_status [get, set] |
| Status of the submitted job. | |
| bool | running [get, set] |
| True if the end point is still executing. | |
| int | progress [get, set] |
| Approximate percentage of the job completed. | |
| bool | successful [get, set] |
| True if the job execution completed and no errors were encountered. | |
| string | response_encoding [get, set] |
| The encoding of the job result (contained in GetJobResponse.job_response or GetJobResponse.job_response_str. | |
| byte[] | job_response [get, set] |
| The binary-encoded response of the job. | |
| string | job_response_str [get, set] |
| The json-encoded response of the job. | |
| IDictionary< string, string > | status_map = new Dictionary<string, string>() [get, set] |
| Map of various status strings for the executed job. | |
| IDictionary< string, string > | info = new Dictionary<string, string>() [get, set] |
| Additional information. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of results returned by Kinetica.getJob.
Property Documentation
◆ endpoint
| getset |
◆ info
| getset |
◆ job_response
| getset |
The binary-encoded response of the job.
This field is populated only when the job has completed and GetJobResponse.response_encoding is BINARY.
◆ job_response_str
| getset |
The json-encoded response of the job.
This field is populated only when the job has completed and GetJobResponse.response_encoding is JSON.
◆ job_status
| getset |
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 GetJobResponse.job_response or GetJobResponse.job_response_str field.
- ERROR: The job was attempted, but an error was encountered. The GetJobResponse.status_map contains the details of the error in error_message.
- CANCELLED: Job cancellation was requested while the execution was in progress.
◆ progress
| getset |
◆ response_encoding
| getset |
The encoding of the job result (contained in GetJobResponse.job_response or GetJobResponse.job_response_str.
Supported values:
- BINARY: The job result is binary-encoded. It is contained in GetJobResponse.job_response.
- JSON: The job result is JSON-encoded. It is contained in GetJobResponse.job_response_str.
◆ running
| getset |
◆ status_map
| getset |
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.
◆ successful
| getset |
The documentation for this class was generated from the following files: