Task Complex Type

  • Article

Defines a task.

<xs:complexType name="Task">
    <xs:sequence>
        <xs:element name="EnvironmentVariables"
            type="NameValueCollection1"
            minOccurs="0"
            maxOccurs="1"
         />
        <xs:element name="CustomProperties"
            type="NameValueCollection"
            minOccurs="0"
            maxOccurs="1"
         />
        <xs:element name="ExtendedTerms"
            type="NameValueCollection1"
            minOccurs="0"
            maxOccurs="1"
         />
    </xs:sequence>
    <xs:attribute name="Version"
        type="decimal"
     />
    <xs:attribute name="Name"
        type="string"
     />
    <xs:attribute name="State"
        type="TaskState"
        default="Configuring"
     />
    <xs:attribute name="PreviousState"
        type="TaskState"
        default="Configuring"
     />
    <xs:attribute name="ParentJobId"
        type="int"
        default="0"
     />
    <xs:attribute name="RuntimeSeconds"
        type="int"
     />
    <xs:attribute name="InstanceId"
        type="int"
     />
    <xs:attribute name="InstanceValue"
        type="int"
     />
    <xs:attribute name="UnitType"
        type="UnitType"
        default="Core"
     />
    <xs:attribute name="MinCores"
        type="int"
        default="1"
     />
    <xs:attribute name="MaxCores"
        type="int"
        default="1"
     />
    <xs:attribute name="MinNodes"
        type="int"
        default="1"
     />
    <xs:attribute name="MaxNodes"
        type="int"
        default="1"
     />
    <xs:attribute name="MinSockets"
        type="int"
        default="1"
     />
    <xs:attribute name="MaxSockets"
        type="int"
        default="1"
     />
    <xs:attribute name="NiceId"
        type="int"
     />
    <xs:attribute name="Id"
        type="int"
        default="0"
     />
    <xs:attribute name="CommandLine"
        type="string"
     />
    <xs:attribute name="RequiredNodes"
        type="string"
     />
    <xs:attribute name="DependsOn"
        type="string"
     />
    <xs:attribute name="IsParametric"
        type="boolean"
        default="false"
     />
    <xs:attribute name="IsExclusive"
        type="boolean"
        default="false"
     />
    <xs:attribute name="IsRerunnable"
        type="boolean"
        default="true"
     />
    <xs:attribute name="ErrorMessage"
        type="string"
     />
    <xs:attribute name="ExitCode"
        type="int"
        default="0"
     />
    <xs:attribute name="GroupId"
        type="int"
     />
    <xs:attribute name="StdOutFilePath"
        type="string"
     />
    <xs:attribute name="StdInFilePath"
        type="string"
     />
    <xs:attribute name="StdErrFilePath"
        type="string"
     />
    <xs:attribute name="WorkDirectory"
        type="string"
     />
    <xs:attribute name="StartValue"
        type="int"
     />
    <xs:attribute name="EndValue"
        type="int"
     />
    <xs:attribute name="IncrementValue"
        type="int"
     />
    <xs:attribute name="Output"
        type="string"
     />
    <xs:attribute name="RequestCancel"
        type="string"
     />
    <xs:attribute name="Closed"
        type="boolean"
     />
    <xs:attribute name="RequeueCount"
        type="int"
     />
    <xs:attribute name="FailureReason"
        type="string"
     />
    <xs:attribute name="PendingReason"
        type="string"
     />
    <xs:attribute name="SubmitTime"
        type="string"
     />
    <xs:attribute name="CreateTime"
        type="string"
     />
    <xs:attribute name="StartTime"
        type="string"
     />
    <xs:attribute name="EndTime"
        type="string"
     />
    <xs:attribute name="ChangeTime"
        type="string"
     />
    <xs:attribute name="ErrorCode"
        type="int"
     />
    <xs:attribute name="ErrorParams"
        type="string"
     />
    <xs:attribute name="ParentJobState"
        type="JobState"
        default="Configuring"
     />
    <xs:attribute name="AutoRequeueCount"
        type="int"
     />
    <xs:attribute name="TaskOwner"
        type="string"
        default="Infinite"
     />
    <xs:attribute name="ProcessIds"
        type="string"
        default="Infinite"
     />
    <xs:attribute name="RecordId"
        type="int"
     />
    <xs:attribute name="ParametricRunningCount"
        type="int"
     />
    <xs:attribute name="ParametricCanceledCount"
        type="int"
     />
    <xs:attribute name="ParametricFailedCount"
        type="int"
     />
    <xs:attribute name="ParametricQueuedCount"
        type="int"
     />
    <xs:attribute name="HasCustomProps"
        type="boolean"
     />
</xs:complexType>

Child elements

Element Type Description
CustomProperties NameValueCollection

A collection of custom properties that the task uses. See ISchedulerTask::GetCustomProperties.
EnvironmentVariables NameValueCollection1

A collection of environment variables that the task uses. See ISchedulerTask.EnvironmentVariables.
ExtendedTerms NameValueCollection1

Do not use. Use CustomProperties instead.

Microsoft Compute Cluster Server 2003:  A collection of extended terms that the task uses.

Attributes

Name Type Description
AutoRequeueCount int

The number of times that the system reran the task when a system error occurred. See TaskPropertyIds.AutoRequeueCount.
ChangeTime string

The last time that the user or server changed a property of the task. See ISchedulerTask.ChangeTime.
Closed boolean

Indicates whether the task was closed. See ITaskPropertyIds.Closed.
CommandLine string

The command line for the task. See ISchedulerTask.CommandLine.
CreateTime string

The time that the task was created. See ISchedulerTask.CreateTime.
DependsOn string

A semicolon-delimited list of the tasks on which this task depends. See ISchedulerTask.DependsOn.
EndTime string

The time that the task finished running. See ISchedulerTask.EndTime.
EndValue int

The ending value for a parametric task. See ISchedulerTask.EndValue.
ErrorCode int

An error code that identifies the error that occurred while running or trying to run the task. See TaskPropertyIds.ErrorCode.
ErrorMessage string

The task-related error message or the message specified when the user canceled the task. See ISchedulerTask.ErrorMessage.
ErrorParams string

A delimited list of insertion strings that are inserted into the message string. See TaskPropertyIds.ErrorParams.
ExitCode int

The exit code that the task set. See ISchedulerTask.ExitCode.
FailureReason string

The reason that the task failed. See TaskPropertyIds.FailureReason.
GroupId int

The task group to which the task belongs. See TaskPropertyIds.GroupId.
HasCustomProps boolean

Determines whether the task contains user-defined properties. See TaskPropertyIds.HasCustomProperties.
Id int

An identifier that uniquely identifies the task within the scheduler store. See TaskPropertyIds.Id.
IncrementValue int

The number by which to increment the instance value for a parametric task. See ISchedulerTask.IncrementValue.
InstanceId int

An identifier that uniquely identifies the instance of a parametric task in the scheduler store. See TaskPropertyIds.InstanceId.
InstanceValue int

The value used for the parametric instance. See See TaskPropertyIds.InstanceValue.
IsExclusive boolean

Determines whether other tasks from the job can run on the node at the same time as this task. See ISchedulerTask.IsExclusive.
IsParametric boolean

Determines whether the task is a parametric task. See ISchedulerTask.IsParametric.
IsRerunnable boolean

Determines whether the task can run again after a failure. See ISchedulerTask.IsRerunnable.
MaxCores int

The maximum number of cores that the scheduler may allocate for the task. See ISchedulerTask.MaximumNumberOfCores.
MaxNodes int

The maximum number of nodes that the scheduler may allocate for the task. See ISchedulerTask.MaximumNumberOfNodes.
MaxSockets int

The maximum number of sockets that the scheduler may allocate for the task. See ISchedulerTask.MaximumNumberOfSockets.
MinCores int

The minimum number of cores that the task requires to run. See ISchedulerTask.MinimumNumberOfCores.
MinNodes int

The minimum number of nodes that the task requires to run. See ISchedulerTask.MinimumNumberOfNodes.
MinSockets int

The minimum number of sockets that the task requires to run. See ISchedulerTask.MinimumNumberOfSockets.
Name string

The display name of the task. See ISchedulerTask.Name.
NiceId int

An identifier that uniquely identifies the task in a job. See the JobTaskId member of ISchedulerTask.TaskId.
Output string

The output generated by the task. See ISchedulerTask.Output.
ParametricCanceledCount int

The number of parametric tasks that were canceled.
ParametricFailedCount int

The number of parametric tasks that failed.
ParametricQueuedCount int

The number of parametric tasks that are queued.
ParametricRunningCount int

The number of parametric tasks that are running.
ParentJobId int

The identifier of the parent job. See ISchedulerTask.ParentJobId.
ParentJobState JobState

The state of the job that contains this task. See TaskPropertyIds.ParentJobState.
PendingReason string

The reason that the task is pending. See TaskPropertyIds.PendingReason.
PreviousState TaskState

The previous state of the task. See ISchedulerTask.PreviousState.
ProcessIds string

A command-delimited list of the process identifiers associated with the task. See TaskPropertyIds.ProcessIds.
RecordId int

For internal use only.
RequestCancel string

Indicates whether the user has requested that the task be canceled. See ITaskPropertyIds.RequestCancel.
RequeueCount int

The number of times that the task has been queued again. See ISchedulerTask.RequeueCount.
RequiredNodes string

A semicolon-delimited list of the nodes that the task requires. See ISchedulerTask.RequiredNodes.
RuntimeSeconds int

The run-time limit for the task. See ISchedulerTask.Runtime.
StartTime string

The time that the task started running. See ISchedulerTask.StartTime.
StartValue int

The starting instance value for a parametric task. See ISchedulerTask.StartValue.
State TaskState

The state of the task. See ISchedulerTask.State.
StdErrFilePath string

The path to which the server redirects standard error. See ISchedulerTask.StdErrFilePath.
StdInFilePath string

The path from which the server redirects standard input. See ISchedulerTask.StdInFilePath.
StdOutFilePath string

The path to which the server redirects standard output. See ISchedulerTask.StdOutFilePath.
SubmitTime string

The time that the task was submitted. See ISchedulerTask.SubmitTime.
TaskOwner string

The owner of the task. See TaskPropertyIds.TaskOwner.
UnitType UnitType

Determines whether cores, nodes, or sockets are used to allocate resources for the task. See ISchedulerJob.UnitType.
Version decimal

The file version of the HPC server assembly. The decimal value is in the form, Major.Minor. See IScheduler::GetServerVersion.
WorkDirectory string

The directory in which to start the task. See ISchedulerTask.WorkDirectory.

Requirements

Product

HPC Pack 2008 Client Utilities