search
Creates, updates, deletes, gets or lists a search resource.
Overview
| Name | search |
| Type | Resource |
| Id | sumologic.parsers.search |
Fields
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
item | object | |
path | string | Path of the folder or parser. (example: /Parsers/SampleFolder/TestParser) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | query, region | limit, offset | Search for a folder or parser in the cloud SIEM parsers library structure. |
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 |
|---|---|---|
query | string | The search query to find folder or parsers. Below is the list of different filters with examples: - createdBy : Filter by the user's identifier who created the content. Example: createdBy:000000000000968B. - createdBefore : Filter by the content objects created before the given timestamp(in milliseconds). Example: createdBefore:1457997222. - createdAfter : Filter by the content objects created after the given timestamp(in milliseconds). Example: createdAfter:1457997111. - modifiedBefore : Filter by the content objects modified before the given timestamp(in milliseconds). Example: modifiedBefore:1457997222. - modifiedAfter : Filter by the content objects modified after the given timestamp(in milliseconds). Example: modifiedAfter:1457997111. - type : Filter by the type of the content object. Example: type:folder. You can also use multiple filters in one query. For example to search for all content objects created by user with identifier 000000000000968B with creation timestamp after 1457997222 containing the text Test, the query would look like: createdBy:000000000000968B createdAfter:1457997222 Test |
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) |
limit | integer (int32) | Maximum number of items you want in the response. |
offset | integer (int32) | The position or row from where to start the search operation. |
SELECT examples
- list
Search for a folder or parser in the cloud SIEM parsers library structure.
SELECT
item,
path
FROM sumologic.parsers.search
WHERE query = '{{ query }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
;