messages

Creates, updates, deletes, gets or lists a messages resource.

Overview

Name	messages
Type	Resource
Id	sumologic.search_jobs.messages

Fields

The following fields are returned by SELECT queries:

list

A paginated list of messages.

Name	Datatype	Description
map	object	Map message values.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	job_id, offset, limit, region		Use the search job identifier to obtain the paginated messages from an offset.

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 search job. (wire: jobId)
limit	integer	Limit the number of messages returned in the response. The number of messages returned may be less than the limit.
offset	integer	Return messages starting at this offset.
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

list

Use the search job identifier to obtain the paginated messages from an offset.

SELECT
map
FROM sumologic.search_jobs.messages
WHERE job_id = '{{ job_id }}' -- required
AND offset = '{{ offset }}' -- required
AND limit = '{{ limit }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;