ISchedulerTask Members

Defines a task.

The following tables list the members exposed by the ISchedulerTask type.

  Name Description
public property AllocatedCoreIds Gets the identifiers of the processor cores that have been allocated to run the task or that have run the task.
public property AllocatedNodes Retrieves the names of the nodes that have been allocated to run the task or have run the task.
public property ChangeTime The last time that the user or server changed a property of the task.
public property CommandLine Retrieves or sets the command line for the task.
public property CreateTime Retrieves the date and time when the task was created.
public property DependsOn Retrieves or sets the dependent tasks.
public property EncryptedUserBlob The encrypted user blob.
public property EndTime Retrieves the date and time that the task ended.
public property EndValue Retrieves or sets the ending value for a parametric task.
public property EnvironmentVariables Retrieves the environment variables that were set for the task.
public property ErrorMessage Retrieves the task-related error message or task cancellation message.
public property ExitCode Retrieves the exit code that the task set.
public property FailJobOnFailure Gets or sets whether the task is critical for the job. If a task is critical for the job, the job and its tasks stop running and the job is immediately marked as failed if the task fails.
public property FailJobOnFailureCount Gets or sets the number of subtasks of a critical parametric sweep or service task that must fail before the job and its tasks and subtask should stop running and the task and job should be marked as failed.
public property HasRuntime Determines whether the Runtime task property is set.
public property IncrementValue Retrieves or sets the number by which to increment the instance value for a parametric task.
public property IsExclusive Determines whether other tasks from the job can run on the node at the same time as this task.
public property IsParametric Determines whether the task is a parametric task. Obsolete.
public property IsRerunnable Determines whether the task can run again after the task is preempted or fails because of an issue with the HPC cluster, or after a node that is running the task is forced offline.
public property IsServiceConcluded Gets whether the HPC Job Scheduler Service has concluded starting subtasks for a service task.
public property MaximumNumberOfCores Retrieves or sets the maximum number of cores that the scheduler may allocate for the task.
public property MaximumNumberOfNodes Retrieves or sets the maximum number of nodes that the scheduler may allocate for the task.
public property MaximumNumberOfSockets Retrieves or sets the maximum number of sockets that the scheduler may allocate for the task.
public property MinimumNumberOfCores Retrieves or sets the minimum number of cores that the task requires to run.
public property MinimumNumberOfNodes Retrieves or sets the minimum number of nodes that the task requires to run.
public property MinimumNumberOfSockets Retrieves or sets the minimum number of sockets that the task requires to run.
public property Name Retrieves or sets the display name of the task.
public property Output Retrieves the output generated by the command.
public property ParentJobId Retrieves the identifier of the parent job.
public property PreviousState Retrieves the previous state of the task.
public property RequeueCount Retrieves the number of times that the task has been queued again.
public property RequiredNodes Retrieves or sets the list of required nodes for the task.
public property Runtime Retrieves or sets the run-time limit for the task.
public property StartTime Retrieves the date and time that the task started running.
public property StartValue Retrieves or sets the starting instance value for a parametric task.
public property State Retrieves the state of the task.
public property StdErrFilePath Retrieves or sets the path to which the server redirects standard error.
public property StdInFilePath Retrieves or sets the path from which the server redirects standard input.
public property StdOutFilePath Retrieves or sets the path to which the server redirects standard output.
public property SubmitTime Retrieves the time that the task was submitted.
public property TaskId Retrieves the identifiers that uniquely identify the task.
public property Type Gets or sets a task type that defines how to run the command for the task.
public property UserBlob Retrieves or sets the user data associated with the task.
public property ValidExitCodes Gets or sets the exit codes to be used for checking whether tasks in the job successfully exit.
public property WorkDirectory Retrieves or sets the directory in which to start the task.
Top

  Name Description
public method Commit Commits the local task changes to the server.
public method GetCounters Retrieves the counter data for the task.
public method GetCustomProperties Retrieves the application-defined properties that were added to the task.
public method Refresh Refreshes this copy of the task with the contents from the server.
public method ServiceConclude Directs the HPC Job Scheduler Service to stop starting subtasks for a service task.
public method SetCustomProperty Sets an application-defined property on the task.
public method SetEnvironmentVariable Sets a task-specific environment variable.
Top




Build Date:

2013-04-22

Community Additions

Show: