CancelJob

Method

CancelJob(CancelJobParameters parameters)

This method cancels an in-progress job.

Parameters

The CancelJob method requires the parameters parameter of type CancelJobParameters.

CancelJobParameters

An instance of CancelJobParameters is passed into the CancelJob method to identify the specific job that should be canceled.

Constructors

CancelJobParameters()

CancelJobParameters(Guid jobId)

Properties

Data Type	Properties	Description
Guid	JobId	Returns or sets the ID of the job to cancel.

Inheritance

JobParameters

The JobParameters class is an abstract class utilized by other parameter classes relating to job methods. It does not contain any unique properties.

Returns

CancelJobResult

An instance of CancelJobResult is returned from the CancelJob method.

Properties

Data Type	Property	Description
JobStatus	Status Valid values include: Pending Processing Success Failed Invalid CancelPending Canceled	The current status of the specified job.

Data Type

Property

Description

JobStatus

Status

Valid values include:

Pending
Processing
Success
Failed
Invalid
CancelPending
Canceled

The current status of the specified job.

Inheritance

JobResult

The JobResult class is utilized by various job subclasses. It offers information about the ID of the job being worked with and the date of its creation.

Properties

Data Type	Property	Description
Guid	JobId	Returns or sets the unique ID of the specified job.
DateTime	CreatedDate	Returns or sets the date the specified job was created.