SchedulerJob Class
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.
Manages the tasks and resources that are associated with a job.
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("B2934CF1-FBD1-42A0-8767-8AC5DDE1618D")]
public class SchedulerJob : Microsoft.Hpc.Scheduler.SchedulerObjectBase, Microsoft.Hpc.Scheduler.ISchedulerJob, Microsoft.Hpc.Scheduler.ISchedulerJobV2, Microsoft.Hpc.Scheduler.ISchedulerJobV3, Microsoft.Hpc.Scheduler.ISchedulerJobV3SP1, Microsoft.Hpc.Scheduler.ISchedulerJobV3SP2, Microsoft.Hpc.Scheduler.ISchedulerJobV3SP3, Microsoft.Hpc.Scheduler.ISchedulerJobV4, Microsoft.Hpc.Scheduler.ISchedulerJobV4SP1, Microsoft.Hpc.Scheduler.ISchedulerJobV4SP2, Microsoft.Hpc.Scheduler.ISchedulerJobV4SP3type SchedulerJob = class
inherit SchedulerObjectBase
interface ISchedulerJob
interface ISchedulerJobV3
interface ISchedulerJobV2
interface ISchedulerJobV3SP1
interface ISchedulerJobV3SP2
interface ISchedulerJobV3SP3
interface ISchedulerJobV4
interface ISchedulerJobV4SP1
interface ISchedulerJobV4SP2
interface ISchedulerJobV4SP3Public Class SchedulerJob
Inherits SchedulerObjectBase
Implements ISchedulerJob, ISchedulerJobV2, ISchedulerJobV3, ISchedulerJobV3SP1, ISchedulerJobV3SP2, ISchedulerJobV3SP3, ISchedulerJobV4, ISchedulerJobV4SP1, ISchedulerJobV4SP2, ISchedulerJobV4SP3- Inheritance
- Attributes
- Implements
Constructors
| SchedulerJob(ISchedulerStore) |
Initializes of new instance of the SchedulerJob class. |
| SchedulerJob(Scheduler) |
Initializes a new instance of this class using the specified scheduler object. |
Fields
| _changeProps |
A dictionary of the properties that have been changed but not yet committed. |
| _job |
The internal job object. |
| _props |
All the properties that have been cached for the object. (Inherited from SchedulerObjectBase) |
| _store |
The internal store object. |
Properties
| AllocatedNodes |
Retrieves the names of the nodes that have been allocated to run the tasks in the job or have run the tasks. |
| AutoCalculateMax |
Determines whether the scheduler automatically calculates the maximum resource value. |
| AutoCalculateMin |
Determines whether the scheduler automatically calculates the minimum resource value. |
| CanGrow |
Determines whether the job resources can grow. |
| CanPreempt |
Determines whether another job can preempt this job. |
| CanShrink |
Determines whether the job resources can shrink. |
| ChangeTime |
Retrieves the last time that the user or server changed a property of the job. |
| ChildJobIds | |
| ClientSource |
Retrieves the name of the process that created the job. |
| CreateTime |
Retrieves the date and time that the job was created. |
| EmailAddress | |
| EndpointAddresses |
Retrieves the unique network addresses that a client uses to communicate with a service endpoint. |
| EndTime |
Retrieves the date and time that job ended. |
| EnvironmentVariables | |
| ErrorMessage |
Retrieves the job-related error message or job cancellation message. |
| EstimatedProcessMemory | |
| ExcludedNodes | |
| ExpandedPriority | |
| FailDependentTasks | |
| FailOnTaskFailure |
Determines whether the job fails when one of the tasks in the job fails. |
| HasRuntime |
Determines whether the job has set the Runtime job property. |
| HoldUntil | |
| Id |
Retrieves the job identifier. |
| IsExclusive |
Determines whether nodes should be exclusively allocated to the job. |
| JobTemplate |
Retrieves the name of the job template used to initialize the properties of the job. |
| MaxCoresPerNode |
Retrieves or sets the maximum number of cores that a node can have for the job to run on it. |
| MaximumNumberOfCores |
Retrieves or sets the maximum number of cores that the scheduler may allocate for the job. |
| MaximumNumberOfNodes |
Retrieves or sets the maximum number of nodes that the scheduler may allocate for the job. |
| MaximumNumberOfSockets |
Retrieves or sets the maximum number of sockets that the scheduler may allocate for the job. |
| MaxMemory |
Retrieves or sets the maximum amount of memory that a node may have for the job to run on it. |
| MinCoresPerNode |
Retrieves or sets the minimum number of cores that a node must have for the job to run on it. |
| MinimumNumberOfCores |
Retrieves or sets the minimum number of cores that the job requires to run. |
| MinimumNumberOfNodes |
Retrieves or sets the minimum number of nodes that the job requires to run. |
| MinimumNumberOfSockets |
Retrieves or sets the minimum number of sockets that the job requires to run. |
| MinMemory |
Retrieves or sets the minimum amount of memory that a node must have for the job to run on it. |
| Name |
Retrieves or sets the display name of the job. |
| NodeGroupOp | |
| NodeGroups |
Retrieves or sets the names of the node groups that define the nodes on which the job can run. |
| NotifyOnCompletion | |
| NotifyOnStart | |
| OrderBy |
Retrieves or sets the preference given to the order in which the job is scheduled on nodes. |
| Owner |
Retrieves the name of the user who created, submitted, or queued the job. |
| ParentJobIds | |
| PlannedCoreCount | |
| Pool | |
| PreviousState |
Retrieves the previous state of the job. |
| Priority |
Retrieves or sets the job priority. |
| Progress | |
| ProgressMessage | |
| Project |
Retrieves or sets the project name to associate with the job. |
| RequestedNodes |
Retrieves or sets the list of nodes that are requested for the job. |
| RequeueCount |
Retrieves the number of times that the job has been queued again. |
| Runtime |
Retrieves or sets the run-time limit for the job. |
| RuntimeType | |
| RunUntilCanceled |
Determines whether the server reserves resources for the job until the job is canceled (even if the job has no active tasks). |
| ServiceName | |
| SingleNode | |
| SoftwareLicense |
Retrieves or sets the software licensing requirements for the job. |
| StartTime |
The date and time that the job started running. |
| State |
Retrieves the state of the job. |
| SubmitTime |
Retrieves the time that the job was submitted. |
| TargetResourceCount | |
| TaskExecutionFailureRetryLimit | |
| UnitType |
Determines whether cores, nodes, or sockets are used to allocate resources for the job. |
| UserName |
Retrieves or sets the RunAs user for the job. |
| ValidExitCodes | |
Methods
Events
| OnJobState |
An event that is raised when the state of the job changes. |
| OnTaskState |
An event that is raised when the state of one of the tasks in the job changes. |
Explicit Interface Implementations
| ISchedulerJob.OnJobState |
An event that is raised when the state of the job changes. |
| ISchedulerJob.OnTaskState |
An event that is raised when the state of one of the tasks in the job changes. |
| ISchedulerJobV2.OnJobState | |
| ISchedulerJobV2.OnTaskState | |
| ISchedulerJobV3.OnJobState | |
| ISchedulerJobV3.OnTaskState | |
| ISchedulerJobV3SP1.OnJobState | |
| ISchedulerJobV3SP1.OnTaskState | |
| ISchedulerJobV3SP2.OnJobState | |
| ISchedulerJobV3SP2.OnTaskState | |
| ISchedulerJobV3SP3.OnJobState | |
| ISchedulerJobV3SP3.OnTaskState | |
| ISchedulerJobV4.OnJobState | |
| ISchedulerJobV4.OnTaskState | |
| ISchedulerJobV4SP1.OnJobState | |
| ISchedulerJobV4SP1.OnTaskState | |
| ISchedulerJobV4SP2.OnJobState | |
| ISchedulerJobV4SP2.OnTaskState | |
| ISchedulerJobV4SP3.OnJobState | |
| ISchedulerJobV4SP3.OnTaskState | |