sync_jobs

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

Overview

Name	sync_jobs
Type	Resource
Id	sumologic.content_sync.sync_jobs

Fields

The following fields are returned by SELECT queries:

get

Content Sync Job Status

Name	Datatype	Description
progress	integer	Content Sync Job progress percentage.
status	string	Content Sync Job status. (example: Success)

get_current

Last triggered Content Sync Job Details.

Name	Datatype	Description
job_id	string	Content Sync Job Id. (example: 68B6D772B616DC06) (wire: jobId)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	job_id, region		Get Status of Content Sync Job.
get_current	select	region		Get Content Sync Job Id of last triggered job.
create	insert	region, content_list, destination_child_org_info, source_child_org_info		Sync Content and Configuration across Organization.
retry	exec	jobId, region	retryOptions	Retry Content Sync Job by ID to re-execute job.
cancel	exec	jobId, region		Cancel In Progress Sync Job by ID..

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
jobId	string	Id of Content Sync Job
job_id	string	Id of Content Sync 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)
retryOptions	string	Controls which contents to retry

SELECT examples

get

Get Status of Content Sync Job.

SELECT
progress,
status
FROM sumologic.content_sync.sync_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

get_current

Get Content Sync Job Id of last triggered job.

SELECT
job_id
FROM sumologic.content_sync.sync_jobs
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

INSERT examples

create

Sync Content and Configuration across Organization.

INSERT INTO sumologic.content_sync.sync_jobs (
source_child_org_info,
destination_child_org_info,
content_list,
region
)
SELECT 
'{{ source_child_org_info }}' /* required */,
'{{ destination_child_org_info }}' /* required */,
'{{ content_list }}' /* required */,
'{{ region }}'
RETURNING
job_id
;

Manifest

# Description fields are for documentation purposes
- name: sync_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sync_jobs resource.
  - name: source_child_org_info
    value:
      orgId: "{{ orgId }}"
      orgName: "{{ orgName }}"
  - name: destination_child_org_info
    value:
      included:
        - orgId: "{{ orgId }}"
          orgName: "{{ orgName }}"
      excluded:
        - orgId: "{{ orgId }}"
          orgName: "{{ orgName }}"
  - name: content_list
    description: |
      List of Content and Configuration Information.
    value:
      - id: "{{ id }}"
        type: "{{ type }}"
        name: "{{ name }}"
        options: "{{ options }}"

Lifecycle Methods

EXEC variables use wire (API) names.

retry

Retry Content Sync Job by ID to re-execute job.

EXEC sumologic.content_sync.sync_jobs.retry 
@jobId='{{ jobId }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set, 
@retryOptions='{{ retryOptions }}'
;

cancel

Cancel In Progress Sync Job by ID..

EXEC sumologic.content_sync.sync_jobs.cancel 
@jobId='{{ jobId }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;