admin_recommended_folder_jobs
Creates, updates, deletes, gets or lists an admin_recommended_folder_jobs resource.
Overview​
| Name | admin_recommended_folder_jobs |
| Type | Resource |
| Id | sumologic.content.admin_recommended_folder_jobs |
Fields​
The following fields are returned by SELECT queries:
- get
Asynchronous Admin Recommended folder job status.
| 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 Admin Recommended folder job for the given job identifier. If job succeeds, use Admin Recommended Job Result endpoint to fetch top-level content items in Admin Recommended folder. | |
start | exec | region | isAdminMode | Schedule an asynchronous job to get the top-level Admin Recommended content items. You can read more about Admin Recommended folder [here](https:​//help.sumologic.com/Manage/Content_Sharing/Admin_Mode#move-important-content-to-admin-recommended).<br /><br />You get back a identifier of asynchronous job in response to this endpoint. See Asynchronous-Request section for more details on how to work with asynchronous request. |
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 Admin Recommended folder 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. |
SELECT examples​
- get
Get the status of an asynchronous Admin Recommended folder job for the given job identifier. If job succeeds, use Admin Recommended Job Result endpoint to fetch top-level content items in Admin Recommended folder.
SELECT
error,
status,
status_message
FROM sumologic.content.admin_recommended_folder_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- start
Schedule an asynchronous job to get the top-level Admin Recommended content items. You can read more about Admin Recommended folder [here](https:​//help.sumologic.com/Manage/Content_Sharing/Admin_Mode#move-important-content-to-admin-recommended).<br /><br />You get back a identifier of asynchronous job in response to this endpoint. See Asynchronous-Request section for more details on how to work with asynchronous request.
EXEC sumologic.content.admin_recommended_folder_jobs.start
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set,
@isAdminMode='{{ isAdminMode }}'
;