Interface IJobSchedulingClient

Client interface for scheduling and monitoring jobs

Namespace: DNVGL.One.Compute.Core.Scheduling
Assembly: DNVGL.One.Compute.Core.dll
Syntax
public interface IJobSchedulingClient

Methods

View Source

CancelJob(String)

Cancels an executing job.

Declaration
void CancelJob(string jobId)
Parameters
Type Name Description
System.String jobId

The job id.
View Source

CancelJobAsync(String)

Cancels an executing job.

Declaration
Task CancelJobAsync(string jobId)
Parameters
Type Name Description
System.String jobId

The job id.
Returns
Type Description
Task

The cancel task.
View Source

GetJobProperties(String)

Gets job properties for the specified job.

Declaration
JobProperties GetJobProperties(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
JobProperties

The job properties object.
Remarks

This object contains the application properties that were set by the application prior to submitting the job, see and can be accessed through the property indexer on DNVGL.One.Compute.Core.JobProperties.

View Source

GetJobPropertiesAsync(String)

Gets job properties for the specified job.

Declaration
Task<JobProperties> GetJobPropertiesAsync(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
Task<JobProperties>

The job properties object.
Remarks

This object contains the application properties that were set by the application prior to submitting the job, see and can be accessed through the property indexer on DNVGL.One.Compute.Core.JobProperties.

View Source

GetJobs()

Gets the jobs for the current authenticated user.

Declaration
IEnumerable<JobInfo> GetJobs()
Returns
Type Description
IEnumerable<JobInfo>

A sequence of JobInfo.
View Source

GetJobsAsync()

Gets the jobs for the current authenticated user.

Declaration
Task<IEnumerable<JobInfo>> GetJobsAsync()
Returns
Type Description
Task<IEnumerable<JobInfo>>

A sequence of JobInfo.
View Source

GetJobStatus(String)

Gets status info for the specified job.

Declaration
JobInfo GetJobStatus(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
JobInfo

The job info object.
View Source

GetJobStatusAsync(String)

Gets status info for the specified job.

Declaration
Task<JobInfo> GetJobStatusAsync(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
Task<JobInfo>

The job info object.
View Source

GetWorkItemInfo(String)

Gets status info for the work items for the specified job.

Declaration
IEnumerable<WorkItemInfo> GetWorkItemInfo(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
IEnumerable<WorkItemInfo>

A sequence of WorkItemInfo, one for each work item in the job.
View Source

GetWorkItemInfo(String, String)

Gets status info for the specified work item.

Declaration
WorkItemInfo GetWorkItemInfo(string jobId, string workItemId)
Parameters
Type Name Description
System.String jobId

The job identifier.
System.String workItemId

The work item identifier.
Returns
Type Description
WorkItemInfo

The work item status info object.
View Source

GetWorkItemInfoAsync(String)

Gets status info for the work items for the specified job.

Declaration
Task<IEnumerable<WorkItemInfo>> GetWorkItemInfoAsync(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
Task<IEnumerable<WorkItemInfo>>

A sequence of WorkItemInfo, one for each work item in the job.
View Source

GetWorkItemInfoAsync(String, String)

Gets status info for the specified work item.

Declaration
Task<WorkItemInfo> GetWorkItemInfoAsync(string jobId, string workItemId)
Parameters
Type Name Description
System.String jobId

The job identifier.
System.String workItemId

The work item identifier.
Returns
Type Description
Task<WorkItemInfo>

The work item status info object.
View Source

GetWorkItemProperties(String)

Gets application properties for the work items of the specified job.

Declaration
IEnumerable<WorkItemProperties> GetWorkItemProperties(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
IEnumerable<WorkItemProperties>

A sequence of DNVGL.One.Compute.Core.WorkItemProperties, one for each work item in the job.
Remarks

This object contains the application properties that were set by the application prior to submitting the job, see and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

View Source

GetWorkItemProperties(String, String)

Gets application properties for the work item given by the jobId and workItemId.

Declaration
WorkItemProperties GetWorkItemProperties(string jobId, string workItemId)
Parameters
Type Name Description
System.String jobId

The job identifier.
System.String workItemId

The work item identifier.
Returns
Type Description
WorkItemProperties

A DNVGL.One.Compute.Core.WorkItemProperties instance for the given work item.
Remarks

This object contains the application properties that were set by the application prior to submitting the job, see and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

View Source

GetWorkItemPropertiesAsync(String)

Gets application properties for the work items of the specified job.

Declaration
Task<IEnumerable<WorkItemProperties>> GetWorkItemPropertiesAsync(string jobId)
Parameters
Type Name Description
System.String jobId

The job identifier.
Returns
Type Description
Task<IEnumerable<WorkItemProperties>>

A sequence of DNVGL.One.Compute.Core.WorkItemProperties, one for each work item in the job.
Remarks

This object contains the application properties that were set by the application prior to submitting the job, see and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

View Source

GetWorkItemPropertiesAsync(String, String)

Gets application properties for the work item given by the jobId and workItemId.

Declaration
Task<WorkItemProperties> GetWorkItemPropertiesAsync(string jobId, string workItemId)
Parameters
Type Name Description
System.String jobId

The job identifier.
System.String workItemId

The work item identifier.
Returns
Type Description
Task<WorkItemProperties>

A DNVGL.One.Compute.Core.WorkItemProperties instance for the given work item.
Remarks

This object contains the application properties that were set by the application prior to submitting the job, see and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

View Source

GetWorkItemResult(String, String)

Gets the work item result for the specified work item.

Declaration
Result GetWorkItemResult(string jobId, string workItemId)
Parameters
Type Name Description
System.String jobId

The job identifier.
System.String workItemId

The work item identifier.
Returns
Type Description
Result

The Result of the specified work item.
View Source

GetWorkItemResultAsync(String, String)

Gets the work item result for the specified work item.

Declaration
Task<Result> GetWorkItemResultAsync(string jobId, string workItemId)
Parameters
Type Name Description
System.String jobId

The job identifier.
System.String workItemId

The work item identifier.
Returns
Type Description
Task<Result>

The Result of the specified work item.
View Source

GetWorkItemResults(String)

The get work item results.

Declaration
IEnumerable<Result> GetWorkItemResults(string jobId)
Parameters
Type Name Description
System.String jobId

The job id.
Returns
Type Description
IEnumerable<Result>

A sequence of Result objects, one for each work item in the given job.
View Source

GetWorkItemResultsAsync(String)

The get work item results.

Declaration
Task<IEnumerable<Result>> GetWorkItemResultsAsync(string jobId)
Parameters
Type Name Description
System.String jobId

The job id.
Returns
Type Description
Task<IEnumerable<Result>>

A sequence of Result objects, one for each work item in the given job.
View Source

SubmitJob(Job)

Submit the job for execution.

Declaration
string SubmitJob(Job job)
Parameters
Type Name Description
Job job

The job.
Returns
Type Description
System.String

Job id
View Source

SubmitJobAsync(Job, CancellationToken)

Submit the job for execution.

Declaration
Task<string> SubmitJobAsync(Job job, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Job job

The job.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task<System.String>

Job id