admin_recommended_folder_results
Creates, updates, deletes, gets or lists an admin_recommended_folder_results resource.
Overview
| Name | admin_recommended_folder_results |
| Type | Resource |
| Id | sumologic.content.admin_recommended_folder_results |
Fields
The following fields are returned by SELECT queries:
- get
Admin Recommended folder.
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier of the content item. (example: 000000000C1C17C6) |
name | string | The name of the content item. (example: Personal) |
parent_id | string | Identifier of the parent content item. (example: 0000000001C41EF2) (wire: parentId) |
children | array | A list of the content items. |
created_at | string (date-time) | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. (example: 2018-10-16T09:10:00.000Z) (wire: createdAt) |
created_by | string | Identifier of the user who created the resource. (example: 0000000006743FDD) (wire: createdBy) |
description | string | Description of the content item. (example: Personal folder for John Doe) |
is_scheduled | boolean | Indicates whether the content item refers to scheduled search. This field is only relevant to Search content type. (wire: isScheduled) |
item_type | string | Type of the content item. Supported values are: 1. Folder 2. Search 3. Report (for old dashboards) 4. Dashboard (for new dashboards) 5. Lookups (example: Folder) (wire: itemType) |
modified_at | string (date-time) | Last modification timestamp in UTC. (example: 2018-10-16T09:10:00.000Z) (wire: modifiedAt) |
modified_by | string | Identifier of the user who last modified the resource. (example: 0000000006743FE8) (wire: modifiedBy) |
permissions | array | List of permissions the user has on the content item. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | job_id, region | Get result of an Admin Recommended job for the given job identifier. The result will be "Admin Recommended" folder with a list of top-level Admin Recommended content items in children field. |
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) |
SELECT examples
- get
Get result of an Admin Recommended job for the given job identifier. The result will be "Admin Recommended" folder with a list of top-level Admin Recommended content items in children field.
SELECT
id,
name,
parent_id,
children,
created_at,
created_by,
description,
is_scheduled,
item_type,
modified_at,
modified_by,
permissions
FROM sumologic.content.admin_recommended_folder_results
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;