jobs
Creates, updates, deletes, gets or lists a jobs resource.
Overview​
| Name | jobs |
| Type | Resource |
| Id | sumologic.lookup_tables.jobs |
Fields​
The following fields are returned by SELECT queries:
- get
The status of async job with given identifier.
| Name | Datatype | Description |
|---|---|---|
job_id | string | An identifier returned in response to an asynchronous request. (example: 0000000001C41EF2) (wire: jobId) |
lookup_content_id | string | Content id of lookup table on which this operation was performed. (example: 0000000001C41EE4) (wire: lookupContentId) |
user_id | string | User id of user who initiated this operation. (example: 0000000006743FDD) (wire: userId) |
lookup_name | string | Name of lookup table on which this operation was performed. (example: sampleLookup) (wire: lookupName) |
created_at | string (date-time) | Creation time of this job in UTC. (example: 2018-10-16T09:10:00.000Z) (wire: createdAt) |
errors | array | More information about the failures, if the status is Failed. |
lookup_content_path | string | Content path of lookup table on which this operation was performed. (example: /Library/Users/xyz@demo.com/sampleLookup) (wire: lookupContentPath) |
modified_at | string (date-time) | Timestamp in UTC when status was last updated. (example: 2018-10-16T09:10:00.000Z) (wire: modifiedAt) |
request_type | string | Type of asynchronous request made: - BulkMerge - BulkReplace - Truncate (example: BulkMerge) (wire: requestType) |
status | string | Whether or not the request is pending (Pending), in progress (InProgress), has completed successfully (Success), has completed partially with warnings (PartialSuccess) or has completed with an error (Failed). |
status_messages | array | Additional status messages generated if any if the status is Success. (wire: statusMessages) |
warnings | array | More information about the warnings, if the status is PartialSuccess. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | job_id, region | Retrieve the status of a previously made request. If the request was successful, the status of the response object will be Success. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
job_id | string | An identifier returned in response to an asynchronous request. (wire: jobId) |
region | string | Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT) |
SELECT examples​
- get
Retrieve the status of a previously made request. If the request was successful, the status of the response object will be Success.
SELECT
job_id,
lookup_content_id,
user_id,
lookup_name,
created_at,
errors,
lookup_content_path,
modified_at,
request_type,
status,
status_messages,
warnings
FROM sumologic.lookup_tables.jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;