SchedulerTask Class

Reference

Definition

Namespace:: Microsoft.Hpc.Scheduler

Assembly:: Microsoft.Hpc.Scheduler.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines a task.

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("3F3E4C6A-4400-4E60-A974-0F4D6F34CE53")]
public class SchedulerTask : Microsoft.Hpc.Scheduler.SchedulerObjectBase, Microsoft.Hpc.Scheduler.ISchedulerTask, Microsoft.Hpc.Scheduler.ISchedulerTaskV2, Microsoft.Hpc.Scheduler.ISchedulerTaskV3, Microsoft.Hpc.Scheduler.ISchedulerTaskV3SP1, Microsoft.Hpc.Scheduler.ISchedulerTaskV4, Microsoft.Hpc.Scheduler.ISchedulerTaskV4SP1, Microsoft.Hpc.Scheduler.ISchedulerTaskV4SP3

type SchedulerTask = class
    inherit SchedulerObjectBase
    interface ISchedulerTask
    interface ISchedulerTaskV2
    interface ISchedulerTaskV3
    interface ISchedulerTaskV3SP1
    interface ISchedulerTaskV4
    interface ISchedulerTaskV4SP1
    interface ISchedulerTaskV4SP3

Public Class SchedulerTask
Inherits SchedulerObjectBase
Implements ISchedulerTask, ISchedulerTaskV2, ISchedulerTaskV3, ISchedulerTaskV3SP1, ISchedulerTaskV4, ISchedulerTaskV4SP1, ISchedulerTaskV4SP3

Inheritance: Object

SchedulerObjectBase
SchedulerTask

Attributes: ClassInterfaceAttribute ComVisibleAttribute GuidAttribute

Implements: ISchedulerTask ISchedulerTaskV2 ISchedulerTaskV3 ISchedulerTaskV3SP1 ISchedulerTaskV4 ISchedulerTaskV4SP1 ISchedulerTaskV4SP3

Constructors

SchedulerTask()

Initializes of new instance of the SchedulerTask class.

Fields

_changeProps
_props	All the properties that have been cached for the object. (Inherited from SchedulerObjectBase)
_task	The internal task object.

Properties

AllocatedCoreIds
AllocatedNodes	Retrieves the names of the nodes that have been allocated to run the task or have run the task.
ChangeTime	The last time that the user or server changed a property of the task.
CommandLine	Retrieves or sets the command line for the task.
CreateTime	Retrieves the date and time when the task was created.
DependsOn	Retrieves or sets the dependent tasks.
EncryptedUserBlob	The encrypted user blob.
EndTime	Retrieves the date and time that the task ended.
EndValue	Retrieves or sets the ending value for a parametric task.
EnvironmentVariables	Retrieves the environment variables that were set for the task.
ErrorMessage	Retrieves the task-related error message or task cancellation message.
ExecutionFailureRetryCount
ExitCode	Retrieves the exit code that the task set.
ExitIfPossible
FailJobOnFailure
FailJobOnFailureCount
HasRuntime	Determines whether the task has set the Runtime task property.
IncrementValue	Retrieves or sets the number by which to increment the instance value for a parametric task.
IsExclusive	Determines whether other tasks from the job can run on the node at the same time as this task.
IsParametric	Obsolete. Determines whether the task is a parametric task.
IsRerunnable	Determines whether the task can run again after a failure.
IsServiceConcluded
MaximumNumberOfCores	Retrieves or sets the maximum number of cores that the scheduler may allocate for the task.
MaximumNumberOfNodes	Retrieves or sets the maximum number of nodes that the scheduler may allocate for the task.
MaximumNumberOfSockets	Retrieves or sets the maximum number of sockets that the scheduler may allocate for the task.
MinimumNumberOfCores	Retrieves or sets the minimum number of cores that the task requires to run.
MinimumNumberOfNodes	Retrieves or sets the minimum number of nodes that the task requires to run.
MinimumNumberOfSockets	Retrieves or sets the minimum number of sockets that the task requires to run.
Name	Retrieves or sets the display name of the task.
Output	Retrieves the output generated by the command.
ParentJobId	Retrieves the identifier of the parent job.
PreviousState	Retrieves the previous state of the task.
RequestedNodeGroup
RequeueCount	Retrieves the number of times that the task has been queued again.
RequiredNodes	Retrieves or sets the list of required nodes for the task.
Runtime	Retrieves or sets the run-time limit for the task.
StartTime	Retrieves the date and time that the task started running.
StartValue	Retrieves or sets the starting instance value for a parametric task.
State	Retrieves the state of the task.
StdErrFilePath	Retrieves or sets the path to which the server redirects standard error.
StdInFilePath	Retrieves or sets the path from which the server redirects standard input.
StdOutFilePath	Retrieves or sets the path to which the server redirects standard output.
SubmitTime	Retrieves the time that the task was submitted.
TaskId	Retrieves the identifiers that uniquely identify the task.
Type
UserBlob	Retrieves or sets the user data associated with the task.
ValidExitCodes
WorkDirectory	Retrieves or sets the directory in which to start the task.

Methods

_InitFromRow(PropertyRow)	Initializes the object using the contents of the specified property row. (Inherited from SchedulerObjectBase)
Commit()	Commits the local task changes to the server.
GetCounters()	Retrieves counter data for the task.
GetCurrentPropsToReload()	(Inherited from SchedulerObjectBase)
GetCustomProperties()	Retrieves the application-defined properties that were added to the task.
GetPropertyIds()
GetWriteOnlyPropertyIds()	(Inherited from SchedulerObjectBase)
InitFromObject(IClusterStoreObject, PropertyId[])	Initializes the object using the properties from the specified object. (Inherited from SchedulerObjectBase)
InitFromTask(IClusterTask, PropertyId[])
LoadProps(IEnumerable<StoreProperty>)	Loads the specified properties from the store. (Inherited from SchedulerObjectBase)
Refresh()	Refreshes this copy of the task with the contents from the server.
ServiceConclude(Boolean)
SetCustomProperty(String, String)	Sets an application-defined property on the task.
SetEnvironmentVariable(String, String)	Sets a task-specific environment variable.

Applies to