export_jobs
Creates, updates, deletes, gets or lists an export_jobs resource.
Overview
| Name | export_jobs |
| Type | Resource |
| Id | sumologic.content.export_jobs |
Fields
The following fields are returned by SELECT queries:
- get
The status of the export 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 | content_id, job_id, region | is_admin_mode | Get the status of an asynchronous content export request for the given job identifier. On success, use the getExportResult endpoint to get the result of the export job. |
start | exec | id, region | isAdminMode | Schedule an asynchronous export of content with the given identifier. You will get back an asynchronous job identifier on success. Use the getAsyncExportStatus endpoint and the job identifier you got back in the response to track the status of an asynchronous export job.<br />If the content item is a folder, everything under the folder is exported recursively. Keep in mind when exporting large folders that there is a limit of 1000 content objects that can be exported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less.<br />The results from the export are compatible with the Library import feature in the Sumo Logic user interface as well as the API content import job. |
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 |
|---|---|---|
content_id | string | The identifier of the exported content item. (wire: contentId) |
id | string | The identifier of the content item to export. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format. |
job_id | string | The identifier of the asynchronous export 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) |
isAdminMode | string | Set this to "true" if you want to perform the request as a Content Administrator. |
is_admin_mode | string | Set this to "true" if you want to perform the request as a Content Administrator. (wire: isAdminMode) |
SELECT examples
- get
Get the status of an asynchronous content export request for the given job identifier. On success, use the getExportResult endpoint to get the result of the export job.
SELECT
error,
status,
status_message
FROM sumologic.content.export_jobs
WHERE content_id = '{{ content_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND is_admin_mode = '{{ is_admin_mode }}'
;
Lifecycle Methods
EXEC variables use wire (API) names.
- start
Schedule an asynchronous export of content with the given identifier. You will get back an asynchronous job identifier on success. Use the getAsyncExportStatus endpoint and the job identifier you got back in the response to track the status of an asynchronous export job.<br />If the content item is a folder, everything under the folder is exported recursively. Keep in mind when exporting large folders that there is a limit of 1000 content objects that can be exported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less.<br />The results from the export are compatible with the Library import feature in the Sumo Logic user interface as well as the API content import job.
EXEC sumologic.content.export_jobs.start
@id='{{ id }}' --required,
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set,
@isAdminMode='{{ isAdminMode }}'
;