Method
GetJobStatus(JobStatusParameters parameters)
This method is used to get the status of an existing job.
Parameters
The GetJobStatus method required a parameters parameter of type JobStatusParameters.
JobStatusParameters
An instance of JobStatusParameters is passed into the GetJobStatus method. It includes the contextual information required to get the status of an existing job.
Constructors
JobStatusParameters()
JobStatusParameters(Guid jobId)
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
Guid |
JobId |
Returns or sets the ID of the job to retrieve the status of. |
|
bool |
OmitResults |
Returns or sets whether results for each parameter should be omitted. |
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
JobStatusResult
An instance of JobStatusResult is returned by the GetJobStatus method. It contains information about a specified job.
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
DateTime |
ModifiedDate |
Returns a timestamp for the last change made as a result of the job. |
|
Status |
Returns a value indicating the status of the specified job. |
|
|
Int |
ParametersCurrentIndex |
Returns a value indicating which parameter is being executed. |
|
Int |
ParametersRemaining |
Returns a value indicating the remaining number of parameters to execute. |
|
Int |
ParametersTotal |
Returns a value indicating the total number of parameters in the job. |
|
Results |
Returns an array containing information about each executed parameter. |
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. |