install_jobs
Creates, updates, deletes, gets or lists an install_jobs resource.
Overview​
| Name | install_jobs |
| Type | Resource |
| Id | sumologic.apps.install_jobs |
Fields​
The following fields are returned by SELECT queries:
- get
The status of the app install job.
| Name | Datatype | Description |
|---|---|---|
error | object | |
status | string | Whether or not the request is in progress (InProgress), has completed successfully (Success), or has completed with an error (Failed). |
status_message | string | Additional status message generated if the status is not Failed. (wire: statusMessage) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | job_id, region | Get the status of an asynchronous app install request for the given job identifier. |
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 | The identifier of the asynchronous install job. (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
Get the status of an asynchronous app install request for the given job identifier.
SELECT
error,
status,
status_message
FROM sumologic.apps.install_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;