Share via

Job

  • Article

Defines a job.

<xs:complexType name="Job">
    <xs:sequence>
        <xs:element name="ExtendedTerms"
            type="NameValueCollection"
            minOccurs="1"
            maxOccurs="1"
            nillable="true"
         />
        <xs:element name="Tasks"
            type="ArrayOfTask"
            minOccurs="1"
            maxOccurs="1"
            nillable="true"
         />
    </xs:sequence>
    <xs:attribute name="AllocatedNodes"
        type="string"
        default=""
     />
    <xs:attribute name="AskedNodes"
        type="string"
        default=""
     />
    <xs:attribute name="Id"
        type="int"
        default="0"
     />
    <xs:attribute name="IsBackfill"
        type="boolean"
        default="false"
     />
    <xs:attribute name="IsExclusive"
        type="boolean"
        default="true"
     />
    <xs:attribute name="MaximumNumberOfProcessors"
        type="int"
        default="1"
     />
    <xs:attribute name="MinimumNumberOfProcessors"
        type="int"
        default="1"
     />
    <xs:attribute name="ErrorMessage"
        type="string"
        default=""
     />
    <xs:attribute name="Name"
        type="string"
        default=""
     />
    <xs:attribute name="SubmittedBy"
        type="string"
        default=""
     />
    <xs:attribute name="Priority"
        type="JobPriority"
        default="Normal"
     />
    <xs:attribute name="Project"
        type="string"
        default=""
     />
    <xs:attribute name="RunUntilCanceled"
        type="boolean"
        default="false"
     />
    <xs:attribute name="Runtime"
        type="string"
        default="Infinite"
     />
    <xs:attribute name="SoftwareLicense"
        type="string"
        default=""
     />
    <xs:attribute name="Status"
        type="JobStatus"
        default="NotSubmitted"
     />
    <xs:attribute name="User"
        type="string"
        default=""
     />
</xs:complexType>

Child elements

Element Type Description
ExtendedTerms NameValueCollection

Contains zero or more extended job terms. Extended job terms are application-defined terms that can be accessed by the submission and activation filters. For details, see IJob::SetExtendedJobTerm.
Tasks ArrayOfTask

Contains the tasks to run.

Attributes

Name Type Description
AllocatedNodes string

Comma-delimited list of nodes that are allocated to the job. For details, see IResourceUsage::get_AllocatedNodes. The attribute is passed to the activation filter but is ignored when calling the ICluster::CreateJobFromXml method.
AskedNodes string

Comma-delimited list of requested nodes. For details, see IJob::put_AskedNodes.
ErrorMessage string

The job error message set when a run-time error occurs or the job is canceled. For details, see IJob::get_ErrorMessage.
Id int

The job identifier. This attribute is ignored when calling the ICluster::CreateJobFromXml method. Treat this attribute as read-only. For details, see IJob::get_Id.
IsBackfill boolean

Indicates whether the job is running as a backfill job. For details, see IJob::get_IsBackfill. The attribute is passed to the activation filter but is ignored when calling the ICluster::CreateJobFromXml method.
IsExclusive boolean

Indicates whether nodes should be exclusively allocated to the job. For details, see IJob::put_IsExclusive.
MaximumNumberOfProcessors int

The maximum number of processors required by the job. For details, see IJob::put_MaximumNumberOfProcessors.
MinimumNumberOfProcessors int

The minimum number of processors required by the job. For details, see IJob::put_MinimumNumberOfProcessors.
Name string

The display name of the job. For details, see IJob::put_Name.
Priority JobPriority

The priority of the job related to other jobs in the scheduling queue. For details, see IJob::put_Priority.
Project string

The project name that is associated with the job for accounting purposes. For details, see IJob::put_Project.
Runtime string

The run-time limit for the job. For details, see IJob::put_Runtime.
RunUntilCanceled boolean

Indicates whether the resources allocated to a job are reserved until the job is canceled even when it has no active tasks. For details, see IJob::put_RunUntilCanceled.
SoftwareLicense string

The required license features. For details, see IJob::put_SoftwareLicense.
Status JobStatus

The current job status. This attribute is ignored when calling the ICluster::CreateJobFromXml method. For details, see IJob::get_Status.
SubmittedBy string

The name of the user who submitted the job. For details, see IJob::get_SubmittedBy. The attribute is passed to the submission and activation filters but is ignored when calling the ICluster::CreateJobFromXml method.
User string

The RunAs user for the job, if different from the SubmittedBy user. For details, see IJob::put_User.

Remarks

The Job element is of this type.

Requirements

Product

Compute Cluster Pack Client Utilities

See also

Job Schema Complex Types