report_jobs

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

Overview

Name	report_jobs
Type	Resource
Id	sumologic.dashboards.report_jobs

Fields

The following fields are returned by SELECT queries:

get

The status of the report generation job.

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 report generation request for the given job identifier. On success, use the getReportGenerationResult endpoint to get the result of the report generation job.
create	insert	region, action, export_format, template, timezone		Schedule an asynchronous job to generate a report from a template. All items in the template will be included unless specified. See template section for more details on individual templates. Reports can be generated in Pdf or Png format and exported in various methods (ex. direct download). You will get back an asynchronous job identifier on success. Use the getAsyncReportGenerationStatus endpoint and the job identifier you got back in the response to track the status of an asynchronous report generation job.<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
job_id	string	The identifier of the asynchronous report generation 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 the status of an asynchronous report generation request for the given job identifier. On success, use the getReportGenerationResult endpoint to get the result of the report generation job.

SELECT
error,
status,
status_message
FROM sumologic.dashboards.report_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

INSERT examples

create

Schedule an asynchronous job to generate a report from a template. All items in the template will be included unless specified. See template section for more details on individual templates. Reports can be generated in Pdf or Png format and exported in various methods (ex. direct download). You will get back an asynchronous job identifier on success. Use the getAsyncReportGenerationStatus endpoint and the job identifier you got back in the response to track the status of an asynchronous report generation job.<br />

INSERT INTO sumologic.dashboards.report_jobs (
action,
export_format,
timezone,
template,
theme,
export_width,
region
)
SELECT 
'{{ action }}' /* required */,
'{{ export_format }}' /* required */,
'{{ timezone }}' /* required */,
'{{ template }}' /* required */,
'{{ theme }}',
{{ export_width }},
'{{ region }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: report_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the report_jobs resource.
  - name: action
    description: |
      The base class of all report action types. `DirectDownloadReportAction` downloads dashboard from browser. New action types may be supported in the future.
    value:
      actionType: "{{ actionType }}"
  - name: export_format
    value: "{{ export_format }}"
    description: |
      File format of the report. Can be `Pdf` or `Png`. `Pdf` is portable document format. `Png` is portable graphics image format.
  - name: timezone
    value: "{{ timezone }}"
    description: |
      Time zone for the query time ranges. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
  - name: template
    value:
      templateType: "{{ templateType }}"
  - name: theme
    value: "{{ theme }}"
    description: |
      Theme for the report rendering. If absent, the default theme of the dashboard is used.
  - name: export_width
    value: {{ export_width }}
    description: |
      Pixel width of the exported PDF or PNG. If absent, the default width is used.