ISchedulerJob ISchedulerJob ISchedulerJob Interface

Definition

Manages the tasks and resources that are associated with a job.

[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("467218B0-24B8-4B6C-AE7E-AD8A5C1D6C87")]
public interface ISchedulerJob
type ISchedulerJob = interface
Public Interface ISchedulerJob
Derived
Attributes

Properties

AllocatedNodes AllocatedNodes AllocatedNodes

Retrieves the names of the nodes that have been allocated to run the tasks in the job or have run the tasks.

AutoCalculateMax AutoCalculateMax AutoCalculateMax

Determines whether the scheduler automatically calculates the maximum resource value.

AutoCalculateMin AutoCalculateMin AutoCalculateMin

Determines whether the scheduler automatically calculates the minimum resource value.

CanGrow CanGrow CanGrow

Determines whether the job resources can grow.

CanPreempt CanPreempt CanPreempt

Determines whether another job can preempt this job.

CanShrink CanShrink CanShrink

Determines whether the job resources can shrink.

ChangeTime ChangeTime ChangeTime

Retrieves the last time that the user or server changed a property of the job.

ChildJobIds ChildJobIds ChildJobIds
ClientSource ClientSource ClientSource

Retrieves the name of the process that created the job.

CreateTime CreateTime CreateTime

Retrieves the date and time that the job was created.

EmailAddress EmailAddress EmailAddress
EndpointAddresses EndpointAddresses EndpointAddresses

Retrieves the unique network addresses that a client uses to communicate with a service endpoint.

EndTime EndTime EndTime

Retrieves the date and time that job ended.

EnvironmentVariables EnvironmentVariables EnvironmentVariables

Gets the environment variables that are set for the job and their values.

ErrorMessage ErrorMessage ErrorMessage

Retrieves the job-related error message or job cancellation message.

EstimatedProcessMemory EstimatedProcessMemory EstimatedProcessMemory
ExcludedNodes ExcludedNodes ExcludedNodes

Gets the list of nodes that should not be used for the job.

ExpandedPriority ExpandedPriority ExpandedPriority

Gets or sets the priority of the job, using the expanded range of priority values in Microsoft HPC Pack 2008 R2 and later versions.

FailDependentTasks FailDependentTasks FailDependentTasks
FailOnTaskFailure FailOnTaskFailure FailOnTaskFailure

Determines whether the job fails when one of the tasks in the job fails.

HasRuntime HasRuntime HasRuntime

Determines whether the Runtime job property is set.

HoldUntil HoldUntil HoldUntil

Gets the date and time in Coordinated Universal Time that the HPC Job Scheduler Service is waiting until before running the job.

Id Id Id

Retrieves the job identifier.

IsExclusive IsExclusive IsExclusive

Determines whether nodes are exclusively allocated to the job.

JobTemplate JobTemplate JobTemplate

Retrieves the name of the job template used to initialize the properties of the job.

MaxCoresPerNode MaxCoresPerNode MaxCoresPerNode

Retrieves or sets the maximum number of cores that a node can have for the job to run on it.

MaximumNumberOfCores MaximumNumberOfCores MaximumNumberOfCores

Retrieves or sets the maximum number of cores that the scheduler may allocate for the job.

MaximumNumberOfNodes MaximumNumberOfNodes MaximumNumberOfNodes

Retrieves or sets the maximum number of nodes that the scheduler may allocate for the job.

MaximumNumberOfSockets MaximumNumberOfSockets MaximumNumberOfSockets

Retrieves or sets the maximum number of sockets that the scheduler may allocate for the job.

MaxMemory MaxMemory MaxMemory

Retrieves or sets the maximum amount of memory that a node may have for the job to run on it.

MinCoresPerNode MinCoresPerNode MinCoresPerNode

Retrieves or sets the minimum number of cores that a node must have for the job to run on it.

MinimumNumberOfCores MinimumNumberOfCores MinimumNumberOfCores

Retrieves or sets the minimum number of cores that the job requires to run.

MinimumNumberOfNodes MinimumNumberOfNodes MinimumNumberOfNodes

Retrieves or sets the minimum number of nodes that the job requires to run.

MinimumNumberOfSockets MinimumNumberOfSockets MinimumNumberOfSockets

Retrieves or sets the minimum number of sockets that the job requires to run.

MinMemory MinMemory MinMemory

Retrieves or sets the minimum amount of memory that a node must have for the job to run on it.

Name Name Name

Retrieves or sets the display name of the job.

NodeGroupOp NodeGroupOp NodeGroupOp
NodeGroups NodeGroups NodeGroups

Retrieves or sets the names of the node groups that specify the nodes on which the job can run.

NotifyOnCompletion NotifyOnCompletion NotifyOnCompletion

Gets or sets whether or not you want to receive e-mail notification when then job ends.

NotifyOnStart NotifyOnStart NotifyOnStart

Gets or sets whether or not you want to receive e-mail notification when then job starts.

OrderBy OrderBy OrderBy

Retrieves or sets the preference given to the order in which the job is scheduled on nodes.

Owner Owner Owner

Retrieves the name of the user who created, submitted, or queued the job.

ParentJobIds ParentJobIds ParentJobIds
PlannedCoreCount PlannedCoreCount PlannedCoreCount
Pool Pool Pool
PreviousState PreviousState PreviousState

Retrieves the previous state of the job.

Priority Priority Priority

Retrieves or sets the job priority.

Progress Progress Progress

Gets or sets the percentage of the job that is complete.

ProgressMessage ProgressMessage ProgressMessage

Gets or sets a custom status message for the job.

Project Project Project

Retrieves or sets the project name to associate with the job.

RequestedNodes RequestedNodes RequestedNodes

Retrieves or sets the list of nodes that are requested for the job.

RequeueCount RequeueCount RequeueCount

Retrieves the number of times that the job has been queued again.

Runtime Runtime Runtime

Retrieves or sets the run-time limit for the job.

RuntimeType RuntimeType RuntimeType
RunUntilCanceled RunUntilCanceled RunUntilCanceled

Determines whether the server reserves resources for the job until the job is canceled (even if the job has no active tasks).

ServiceName ServiceName ServiceName

Gets or sets the name of the SOA service that the service tasks in the job use, if the job contains service tasks.

SingleNode SingleNode SingleNode
SoftwareLicense SoftwareLicense SoftwareLicense

Retrieves or sets the software licensing requirements for the job.

StartTime StartTime StartTime

Retrieves the date and time that the job started running.

State State State

Retrieves the state of the job.

SubmitTime SubmitTime SubmitTime

Retrieves the time that the job was submitted.

TargetResourceCount TargetResourceCount TargetResourceCount
TaskExecutionFailureRetryLimit TaskExecutionFailureRetryLimit TaskExecutionFailureRetryLimit
UnitType UnitType UnitType

Determines whether cores, nodes, or sockets are used to allocate resources for the job.

UserName UserName UserName

Retrieves or sets the RunAs user for the job.

ValidExitCodes ValidExitCodes ValidExitCodes

Methods

AddExcludedNodes(IStringCollection) AddExcludedNodes(IStringCollection) AddExcludedNodes(IStringCollection)

Adds the specified nodes to the list of nodes that should not be used for the job.

AddTask(ISchedulerTask) AddTask(ISchedulerTask) AddTask(ISchedulerTask)

Adds the task to the job.

AddTasks(ISchedulerTask[]) AddTasks(ISchedulerTask[]) AddTasks(ISchedulerTask[])

Add the specified tasks to the job.

BeginFinishTask(Int32, String, Boolean, AsyncCallback, Object) BeginFinishTask(Int32, String, Boolean, AsyncCallback, Object) BeginFinishTask(Int32, String, Boolean, AsyncCallback, Object)
Cancel(Boolean, Boolean) Cancel(Boolean, Boolean) Cancel(Boolean, Boolean)
CancelTask(ITaskId) CancelTask(ITaskId) CancelTask(ITaskId)

Cancels the specified task.

CancelTask(ITaskId, String) CancelTask(ITaskId, String) CancelTask(ITaskId, String)

Cancels the specified task and provides the specified message to the user to explain the task was canceled.

CancelTask(ITaskId, String, Boolean) CancelTask(ITaskId, String, Boolean) CancelTask(ITaskId, String, Boolean)

Cancels the specified task with the option to specify that you want to cancel the task immediately without using for the grace period for canceling a task, and provides the specified message to the user to explain the task was canceled.

ClearExcludedNodes() ClearExcludedNodes() ClearExcludedNodes()

Removes all of the nodes in the list of nodes that should not be used for the job from that list.

ClearHold() ClearHold() ClearHold()

Removes the hold on the job by clearing the date and time that the HPC Job Scheduler Service should wait until before running the job.

Commit() Commit() Commit()

Commits to the server any local changes to the job.

CreateTask() CreateTask() CreateTask()

Creates a task.

EndFinishTask(IAsyncResult) EndFinishTask(IAsyncResult) EndFinishTask(IAsyncResult)
Finish() Finish() Finish()

Sets the job to the finished state and does not run any additional tasks except node release tasks.

Finish(Boolean, Boolean) Finish(Boolean, Boolean) Finish(Boolean, Boolean)
FinishTask(ITaskId, String) FinishTask(ITaskId, String) FinishTask(ITaskId, String)
GetCounters() GetCounters() GetCounters()

Retrieves the counter data for the job.

GetCustomProperties() GetCustomProperties() GetCustomProperties()

Retrieves the application-defined properties.

GetTaskIdList(IFilterCollection, ISortCollection, Boolean) GetTaskIdList(IFilterCollection, ISortCollection, Boolean) GetTaskIdList(IFilterCollection, ISortCollection, Boolean)

Retrieves a list of task identifiers based on the specified filters.

GetTaskList(IFilterCollection, ISortCollection, Boolean) GetTaskList(IFilterCollection, ISortCollection, Boolean) GetTaskList(IFilterCollection, ISortCollection, Boolean)

Retrieves a list of task objects based on the specified filters.

OpenJobAllocationHistoryEnumerator(IPropertyIdCollection) OpenJobAllocationHistoryEnumerator(IPropertyIdCollection) OpenJobAllocationHistoryEnumerator(IPropertyIdCollection)
OpenTask(ITaskId) OpenTask(ITaskId) OpenTask(ITaskId)

Opens the task using the specified task identifier.

OpenTaskAllocationHistoryEnumerator(IPropertyIdCollection) OpenTaskAllocationHistoryEnumerator(IPropertyIdCollection) OpenTaskAllocationHistoryEnumerator(IPropertyIdCollection)
OpenTaskEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection, Boolean) OpenTaskEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection, Boolean) OpenTaskEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection, Boolean)

Retrieves an enumerator that contains the tasks that match the filter criteria.

OpenTaskRowSet(IPropertyIdCollection, IFilterCollection, ISortCollection, Boolean) OpenTaskRowSet(IPropertyIdCollection, IFilterCollection, ISortCollection, Boolean) OpenTaskRowSet(IPropertyIdCollection, IFilterCollection, ISortCollection, Boolean)

Retrieves a rowset that contains the jobs that match the filter criteria.

Refresh() Refresh() Refresh()

Refreshes this copy of the job with the contents from the server.

RemoveExcludedNodes(IStringCollection) RemoveExcludedNodes(IStringCollection) RemoveExcludedNodes(IStringCollection)

Removes the specified nodes from the list of nodes that should not be used for the job.

Requeue() Requeue() Requeue()
RequeueTask(ITaskId) RequeueTask(ITaskId) RequeueTask(ITaskId)

Queues a task again.

RestoreFromXml(String) RestoreFromXml(String) RestoreFromXml(String)

Overwrites the properties and tasks of the job using the XML at the specified URL.

RestoreFromXml(XmlReader) RestoreFromXml(XmlReader) RestoreFromXml(XmlReader)

Overwrites the properties and tasks of the job using the contents from the XML reader.

RestoreFromXmlEx(String, Boolean) RestoreFromXmlEx(String, Boolean) RestoreFromXmlEx(String, Boolean)
RestoreFromXmlEx(XmlReader, Boolean) RestoreFromXmlEx(XmlReader, Boolean) RestoreFromXmlEx(XmlReader, Boolean)
SetCustomProperty(String, String) SetCustomProperty(String, String) SetCustomProperty(String, String)

Sets an application-defined property on the job.

SetEnvironmentVariable(String, String) SetEnvironmentVariable(String, String) SetEnvironmentVariable(String, String)

Sets the specified environment variable to the specified value in the context of the job.

SetHoldUntil(DateTime) SetHoldUntil(DateTime) SetHoldUntil(DateTime)

Sets the earliest date and time until which the HPC Job Scheduler Service should wait until before starting the job.

SetJobTemplate(String) SetJobTemplate(String) SetJobTemplate(String)

Sets the job template to use for the job.

SubmitTask(ISchedulerTask) SubmitTask(ISchedulerTask) SubmitTask(ISchedulerTask)

Submits a task to the job using the specified task.

SubmitTaskById(ITaskId) SubmitTaskById(ITaskId) SubmitTaskById(ITaskId)

Submits a task to the job using the task identifier to identify the task.

SubmitTasks(ISchedulerTask[]) SubmitTasks(ISchedulerTask[]) SubmitTasks(ISchedulerTask[])

Submits the specified tasks to the job.

Events

OnJobState OnJobState OnJobState

An event that is raised when the state of the job changes.

OnTaskState OnTaskState OnTaskState

An event that is raised when the state of one of the tasks in the job changes.

Applies to