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

CancelJob(string)

Cancels an executing job.

Declaration

void CancelJob(string jobId)

Parameters

Type	Name	Description
string	jobId	The job id.

CancelJobAsync(string)

Cancels an executing job.

Declaration

Task CancelJobAsync(string jobId)

Parameters

Type	Name	Description
string	jobId	The job id.

Returns

Type	Description
Task	The cancel task.

GetJobProperties()

Gets job properties for all jobs of the authenticated user.

Declaration

IEnumerable<JobProperties> GetJobProperties()

Returns

Type	Description
IEnumerable<JobProperties>	A collection of job properties objects for the user's jobs.

Remarks

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

GetJobProperties(string)

Gets job properties for the specified job.

Declaration

JobProperties GetJobProperties(string jobId)

Parameters

Type	Name	Description
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 Properties and can be accessed through the property indexer on DNVGL.One.Compute.Core.JobProperties.

GetJobPropertiesAsync()

Gets job properties for all jobs of the authenticated user.

Declaration

Task<IEnumerable<JobProperties>> GetJobPropertiesAsync()

Returns

Type	Description
Task<IEnumerable<JobProperties>>	A collection of job properties objects for the user's jobs.

Remarks

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

GetJobPropertiesAsync(string)

Gets job properties for the specified job.

Declaration

Task<JobProperties> GetJobPropertiesAsync(string jobId)

Parameters

Type	Name	Description
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 Properties and can be accessed through the property indexer on DNVGL.One.Compute.Core.JobProperties.

GetJobPropertiesInSegments(string)

Gets job properties of jobs in segments of the authenticated user for the specified continuation token.

Declaration

JobPropertiesSegment GetJobPropertiesInSegments(string continuationToken)

Parameters

Type	Name	Description
string	continuationToken	An object representing a continuation token from the server when the operation returns a partial result.

Returns

Type	Description
JobPropertiesSegment	An instance of JobPropertiesSegment.

GetJobPropertiesInSegmentsAsync(string)

Gets job properties of jobs in segments of the authenticated user for the specified continuation token.

Declaration

Task<JobPropertiesSegment> GetJobPropertiesInSegmentsAsync(string continuationToken)

Parameters

Type	Name	Description
string	continuationToken	An object representing a continuation token from the server when the operation returns a partial result.

Returns

Type	Description
Task<JobPropertiesSegment>	An instance of JobPropertiesSegment.

GetJobStatus(string)

Gets status info for the specified job.

Declaration

JobInfo GetJobStatus(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
JobInfo	The job info object.

GetJobStatusAsync(string)

Gets status info for the specified job.

Declaration

Task<JobInfo> GetJobStatusAsync(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
Task<JobInfo>	The job info object.

GetJobs()

Gets the jobs for the current authenticated user.

Declaration

IEnumerable<JobInfo> GetJobs()

Returns

Type	Description
IEnumerable<JobInfo>	A sequence of JobInfo.

GetJobsAsync()

Gets the jobs for the current authenticated user.

Declaration

Task<IEnumerable<JobInfo>> GetJobsAsync()

Returns

Type	Description
Task<IEnumerable<JobInfo>>	A sequence of JobInfo.

GetWorkItemInfo(string)

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

Declaration

IEnumerable<WorkItemInfo> GetWorkItemInfo(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
IEnumerable<WorkItemInfo>	A sequence of WorkItemInfo, one for each work item in the job.

GetWorkItemInfo(string, string)

Gets status info for the specified work item.

Declaration

WorkItemInfo GetWorkItemInfo(string jobId, string workItemId)

Parameters

Type	Name	Description
string	jobId	The job identifier.
string	workItemId	The work item identifier.

Returns

Type	Description
WorkItemInfo	The work item status info object.

GetWorkItemInfoAsync(string)

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

Declaration

Task<IEnumerable<WorkItemInfo>> GetWorkItemInfoAsync(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
Task<IEnumerable<WorkItemInfo>>	A sequence of WorkItemInfo, one for each work item in the job.

GetWorkItemInfoAsync(string, string)

Gets status info for the specified work item.

Declaration

Task<WorkItemInfo> GetWorkItemInfoAsync(string jobId, string workItemId)

Parameters

Type	Name	Description
string	jobId	The job identifier.
string	workItemId	The work item identifier.

Returns

Type	Description
Task<WorkItemInfo>	The work item status info object.

GetWorkItemProperties(string)

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

Declaration

IEnumerable<WorkItemProperties> GetWorkItemProperties(string jobId)

Parameters

Type	Name	Description
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 Properties and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

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
string	jobId	The job identifier.
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 Properties and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

GetWorkItemPropertiesAsync(string)

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

Declaration

Task<IEnumerable<WorkItemProperties>> GetWorkItemPropertiesAsync(string jobId)

Parameters

Type	Name	Description
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 Properties and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

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
string	jobId	The job identifier.
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 Properties and can be accessed through the property indexer on DNVGL.One.Compute.Core.WorkItemProperties.

GetWorkItemResult(string, string)

Gets the work item result for the specified work item.

Declaration

Result GetWorkItemResult(string jobId, string workItemId)

Parameters

Type	Name	Description
string	jobId	The job identifier.
string	workItemId	The work item identifier.

Returns

Type	Description
Result	The Result of the specified work item.

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
string	jobId	The job identifier.
string	workItemId	The work item identifier.

Returns

Type	Description
Task<Result>	The Result of the specified work item.

GetWorkItemResults(string)

The get work item results.

Declaration

IEnumerable<Result> GetWorkItemResults(string jobId)

Parameters

Type	Name	Description
string	jobId	The job id.

Returns

Type	Description
IEnumerable<Result>	A sequence of Result objects, one for each work item in the given job.

GetWorkItemResultsAsync(string)

The get work item results.

Declaration

Task<IEnumerable<Result>> GetWorkItemResultsAsync(string jobId)

Parameters

Type	Name	Description
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.

SubmitJob(Job)

Submit the job for execution.

Declaration

string SubmitJob(Job job)

Parameters

Type	Name	Description
Job	job	The job.

Returns

Type	Description
string	Job identifier.

SubmitJobAsync(Job, CancellationToken)

Submit the job for execution.

Declaration

Task<string> SubmitJobAsync(Job job, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Job	job	The job.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<string>	Job identifier.