ISchedulerTask Interface
Definition
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.ComVisible(true)]
[System.Runtime.InteropServices.Guid("EB8AC320-EEF6-4FD9-9505-79A46B1F0094")]
public interface ISchedulerTask
type ISchedulerTask = interface
Public Interface ISchedulerTask
- Derived
- Attributes
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 Runtime task property is set. |
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 |
Gets or sets a task type that defines how to run the command for the task. |
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
Commit() |
Commits the local task changes to the server. |
GetCounters() |
Retrieves the counter data for the task. |
GetCustomProperties() |
Retrieves the application-defined properties that were added to the task. |
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. |