copy_jobs

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

Overview

Name	copy_jobs
Type	Resource
Id	sumologic.content.copy_jobs

Fields

The following fields are returned by SELECT queries:

get

The status of the content copy 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	id, job_id, region	is_admin_mode	Get the status of the copy request with the given job identifier. On success, field statusMessage will contain identifier of the newly copied content in format: id: &#123;hexIdentifier&#125;.<br />
start	exec	id, destinationFolder, region	isAdminMode	Start an asynchronous content copy job with the given identifier to the destination folder. If the content item is a folder, everything under the folder is copied recursively.

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
destinationFolder	string	The identifier of the destination folder.
id	string	The identifier of the content item to copy. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
job_id	string	The identifier of the asynchronous copy request 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)
isAdminMode	string	Set this to "true" if you want to perform the request as a Content Administrator.
is_admin_mode	string	Set this to "true" if you want to perform the request as a Content Administrator. (wire: isAdminMode)

SELECT examples

get

Get the status of the copy request with the given job identifier. On success, field statusMessage will contain identifier of the newly copied content in format: id: {hexIdentifier}.<br />

SELECT
error,
status,
status_message
FROM sumologic.content.copy_jobs
WHERE id = '{{ id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND is_admin_mode = '{{ is_admin_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

start

Start an asynchronous content copy job with the given identifier to the destination folder. If the content item is a folder, everything under the folder is copied recursively.

EXEC sumologic.content.copy_jobs.start 
@id='{{ id }}' --required, 
@destinationFolder='{{ destinationFolder }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set, 
@isAdminMode='{{ isAdminMode }}'
;