Interface IJobs
Interface wrapper for the Platform Jobs API
Namespace: Nvidia.Clara.DicomAdapter.API
Assembly: Nvidia.Clara.Dicom.API.dll
Syntax
public interface IJobsMethods
| Improve this Doc View SourceAddMetadata(Job, IDictionary<String, String>)
Starts the job
Declaration
Task AddMetadata(Job job, IDictionary<string, string> metadata)Parameters
| Type | Name | Description |
|---|---|---|
| Job | job | Add metadata to a job. |
| IDictionary<String, String> | metadata |
Returns
| Type | Description |
|---|---|
| Task |
Create(String, String, JobPriority, IDictionary<String, String>)
Creates a new job
Declaration
Task<Job> Create(string pipelineId, string jobName, JobPriority jobPriority, IDictionary<string, string> metadata)Parameters
| Type | Name | Description |
|---|---|---|
| String | pipelineId | Pipeline ID to create a new job from. |
| String | jobName | Name of the job. |
| JobPriority | jobPriority | Priority of the job. |
| IDictionary<String, String> | metadata |
Returns
| Type | Description |
|---|---|
| Task<Job> |
Start(Job)
Starts the job
Declaration
Task Start(Job job)Parameters
| Type | Name | Description |
|---|---|---|
| Job | job | Job to start. |
Returns
| Type | Description |
|---|---|
| Task |
Status(String)
Gets status of a job
Declaration
Task<JobDetails> Status(string jobId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId | job id |
Returns
| Type | Description |
|---|---|
| Task<JobDetails> |