root
Creates, updates, deletes, gets or lists a root resource.
Overview
| Name | root |
| Type | Resource |
| Id | sumologic.parsers.root |
Fields
The following fields are returned by SELECT queries:
- get
Root folder in the library.
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier of the folder or parser. |
name | string | Name of the folder or parser. |
parent_id | string | Identifier of the parent folder. (wire: parentId) |
children | array | Children of the folder. |
content_type | string | Type of the content. Valid values: 1) Folder 2) Parser (wire: contentType) |
created_at | string (date-time) | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. (wire: createdAt) |
created_by | string | Identifier of the user who created the resource. (wire: createdBy) |
description | string | Description of the folder or parser. |
is_locked | boolean | Whether the object is locked. (wire: isLocked) |
is_mutable | boolean | Immutable objects are "READ-ONLY". (wire: isMutable) |
is_system | boolean | System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. (wire: isSystem) |
modified_at | string (date-time) | Last modification timestamp in UTC. (wire: modifiedAt) |
modified_by | string | Identifier of the user who last modified the resource. (wire: modifiedBy) |
type | string | Type of the object model. |
version | integer (int64) | Version of the folder or parser. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | region | Get the root folder in the library.<br /> |
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 |
|---|---|---|
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 root folder in the library.<br />
SELECT
id,
name,
parent_id,
children,
content_type,
created_at,
created_by,
description,
is_locked,
is_mutable,
is_system,
modified_at,
modified_by,
type,
version
FROM sumologic.parsers.root
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;