IJob interface
Manages the tasks and resources that are associated with a job.
To create a job, call the ICluster::CreateJob method.
Members
The IJob interface inherits from the IDispatch interface. IJob also has these types of members:
- Methods
Methods
The IJob interface has these methods.
| Method | Description |
|---|---|
| AddTask | Adds the task to the job. |
| Clear | Removes all tasks from the job. |
| get_AskedNodes | Retrieves the list of nodes that are requested for the job. |
| get_CreateTime | Retrieves the job creation time. |
| get_EndTime | Retrieves the job end time. |
| get_ErrorMessage | Retrieves the job error message. |
| get_ExtendedJobTerms | Retrieves the extended job terms. |
| get_Id | Retrieves the job identifier. |
| get_IsBackfill | Checks whether the job is running as a backfill job. |
| get_IsExclusive | Checks whether nodes should be exclusively allocated to the job. |
| get_MaximumNumberOfProcessors | Retrieves the maximum number of processors that are required by the job. |
| get_MinimumNumberOfProcessors | Retrieves the minimum number of processors that are required by the job. |
| get_Name | Retrieves the display name of the job. |
| get_Priority | Retrieves the job priority. |
| get_Project | Retrieves the project name that is associated with the job. |
| get_Runtime | Retrieves the run-time limit for the job. |
| get_RunUntilCanceled | Checks whether the resources that are allocated to a job are reserved for the job even when the job has no active tasks. |
| get_SoftwareLicense | Retrieves information about the required licenses. |
| get_StartTime | Retrieves the time that the job started running. |
| get_Status | Retrieves the current job status. |
| get_SubmittedBy | Retrieves the name of the user who submitted the job. |
| get_SubmitTime | Retrieves the time that the job was submitted. |
| get_TaskCount | Retrieves the number of tasks that are part of the job. |
| get_User | Retrieves the RunAs user for the job. |
| GetEnumerator | Retrieves an enumerator that you use to enumerate the tasks of the job. |
| GetTask | Retrieves the specified task. |
| put_AskedNodes | Sets the list of nodes that are requested for the job. |
| put_IsExclusive | Sets whether nodes should be exclusively allocated to the job. |
| put_MaximumNumberOfProcessors | Sets the maximum number of processors that are required by the job. |
| put_MinimumNumberOfProcessors | Sets the minimum number of processors that are required by the job. |
| put_Name | Sets the display name of the job. |
| put_Priority | Sets the job priority. |
| put_Project | Sets the project name that is associated with the job. |
| put_Runtime | Sets the run-time limit for the job. |
| put_RunUntilCanceled | Sets whether the resources that are allocated to a job are reserved for the job even when the job has no active tasks. |
| put_SoftwareLicense | Sets the required licenses. |
| put_User | Sets the RunAs user for the job. |
| SetExtendedJobTerm | Sets the specified extended job term. |
Requirements
Product |
Compute Cluster Pack Client Utilities |
Type library |
Ccpapi.tlb |