JobDefinition Class
Defines how IIS Transform Manager monitors, creates, schedules, and maintains jobs.
Inheritance Hierarchy
System. . :: . .Object
Microsoft.Web.Media.TransformManager. . :: . .ConfigurationBase
Microsoft.Web.Media.TransformManager..::..JobDefinition
Namespace: Microsoft.Web.Media.TransformManager
Assembly: Microsoft.Web.Media.TransformManager.Common (in Microsoft.Web.Media.TransformManager.Common.dll)
Syntax
'Declaration
<SerializableAttribute> _
<DataContractAttribute> _
Public Class JobDefinition _
Inherits ConfigurationBase
'Usage
Dim instance As JobDefinition
[SerializableAttribute]
[DataContractAttribute]
public class JobDefinition : ConfigurationBase
[SerializableAttribute]
[DataContractAttribute]
public ref class JobDefinition : public ConfigurationBase
[<SerializableAttribute>]
[<DataContractAttribute>]
type JobDefinition =
class
inherit ConfigurationBase
end
public class JobDefinition extends ConfigurationBase
The JobDefinition type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
JobDefinition() () () () | Initializes a new instance of the JobDefinition class. |
|
JobDefinition(FileInfo, XElement) | Initializes a new instance of the JobDefinition class using the specified file and job definition information. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AssetRetentionPeriodDisplayUnit | Gets or sets a value that indicates how long the assets that are associated with a job are retained. |
|
AssetRetentionPeriodMinutes | Gets or sets the number of minutes that the asset files that are associated with a job are retained after they are selected for deletion during maintenance. |
|
BaseNamespace | Gets or sets the XML namespace for the configuration. (Inherited from ConfigurationBase.) |
|
ConcurrentJobs | Gets or sets the number of concurrent jobs that the job manager can start when it uses this job definition. |
|
ConfigurationDirectory | Gets the path of the job definition configuration file. |
|
ConfigurationMessages | Gets or sets a list of IIS Transform Manager configuration messages. (Inherited from ConfigurationBase.) |
|
ConfigurationMessagesElement | Gets or sets an XML element that contains configuration messages for the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
ConfigurationStatus | Gets or sets the IIS Transform Manager configuration status. (Inherited from ConfigurationBase.) |
|
CredentialId | Gets or sets a GUID that identifies the credential that is associated with this job definition. |
|
DeleteCanceledFiles | Gets or sets a value that indicates whether asset files for canceled jobs should be deleted during the maintenance cycle. |
|
DeleteFailedFiles | Gets or sets a value that indicates whether asset files for failed jobs should be deleted during the maintenance cycle. |
|
DeleteFinishedFiles | Gets or sets a value that indicates whether asset files for finished jobs should be deleted during the maintenance cycle. |
|
Description | Gets or sets a description of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
DescriptionElement | Gets or set the XML element that contains the description of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
Enabled | Gets or sets a value that indicates whether the job manager that is associated with this job definition can be started. |
|
EnforceFileNameCase | Gets or sets a value that indicates whether the file names referenced in the manifest must match in case. |
|
FileName | Gets or sets the name of the configuration file for the current job definition. |
|
Id | Gets or sets the XML element ID of a configuration object. (Inherited from ConfigurationBase.) |
|
IdElement | Gets or sets the XML ID element of a configuration object. (Inherited from ConfigurationBase.) |
|
InputFolder | Gets or sets the input folder name. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
InputFolderPath | Gets or sets the input folder path. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
InputIsManifest | Gets or sets a value that indicates whether the file that initiates job creation is a SMIL 2.0-compliant manifest. |
|
IsJobManagerRunning | Gets or sets a value that indicates whether the job manager that is associated with this job definition is running. |
|
JobManagerLogLevel | Gets or sets the threshold value of log entries that are written to the job manager log. |
|
JobManagerLogRolloverIntervalDisplayUnit | Gets or sets the unit of time that is used with the JobDefinition..::..JobManagerLogRolloverIntervalMinutes property to indicate when to create a new log. |
|
JobManagerLogRolloverIntervalMinutes | Gets or sets the number of minutes of log data to collect before a new log file is created. |
|
LastModified | Gets or sets the date and time when the IIS Transform Manager configuration was last modified. (Inherited from ConfigurationBase.) |
|
LocalFileWatcherFilter | Gets or sets a file filter value that is used to initiate job creation. |
|
LogFolder | |
|
LogFolderNameJobInstances | |
|
LogFolderWatchFolderManager | |
|
LogLevel | Gets or sets a value that represents the level of detail for a log that is contained in the log level element of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
LogLevelElement | Gets or sets an XML element that contains log level details. (Inherited from ConfigurationBase.) |
|
LogRetentionPeriodDisplayUnit | Gets or sets the unit of time that is used with the LogRetentionPeriodMinutes property to indicate how long the log file that is associated with a job is retained. |
|
LogRetentionPeriodMinutes | Gets or sets the number of minutes that the log that is associated with a job is retained before being deleted during maintenance. |
|
MaintenanceCommand | |
|
MaintenanceIntervalDisplayUnit | Gets or sets the unit of time that is used with the MaintenanceIntervalMinutes property to indicate how often maintenance is run. |
|
MaintenanceIntervalMinutes | Gets or sets the number of minutes between maintenance-processing activities. |
|
MaintenanceTime | Gets or sets a fixed time during the day to run maintenance. |
|
MaintenanceUseInterval | Gets or sets a value that indicates that maintenance should be run at a specified interval instead of at a fixed time. |
|
Name | Gets or sets the XML element name of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
NameElement | Gets or sets an XML element that contains name details. (Inherited from ConfigurationBase.) |
|
NodeTaskCodePathX64 | Gets or sets a location for x64 binary files. |
|
NodeTaskCodePathX86 | Gets or sets a location for x86 binary files. |
|
NotificationIncludeLogForFailedJob | Gets or sets a value that specifies that the log that is associated with a failed job will be included in a failure notification POST request. |
|
Notifications | Gets or sets a collection of the job notifications that trigger a notification POST request. |
|
NotificationUrl | Gets or sets a URL to which HTTP POST request notifications are sent. |
|
OutputFolder | Gets or sets the output folder for a job. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
OutputFolderPath | Gets or sets the output folder path for a job. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
Priority | Gets or sets the priority of a job. |
|
ProcessPriority | |
|
SchedulerCpuDisplayUnit | Gets or sets an HPC CPU unit value. |
|
SchedulerCpus | Gets or sets a CPU value based on the scheduler. |
|
SchedulerId | Gets or sets the ID of the scheduler that is associated with this job definition. |
|
SchedulerMemory | Gets or sets a memory value based on the scheduler. |
|
SchedulerNodeGroups | Gets or sets a list of compute nodes. |
|
SchedulerProperties | Gets a list of additional scheduler properties. |
|
SchedulerUseNodeProfile | Gets or sets a value that determines whether the HPC scheduler should use the SchedulerCpus, SchedulerMemory, and SchedulerNodeGroups properties when a job is transformed. |
|
TemplateId | Gets or sets the ID of the job template that the JobDefinition object uses. |
|
TemplateName | Gets or sets the name of the job template that the current JobDefinition object uses. |
|
WatchFolder | Gets or sets a file system folder that will be watched for files that will instantiate jobs. |
|
WorkFolder |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddConfigurationMessage(String) | Adds the specified message to the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
AddConfigurationMessage(String, ConfigurationMessageSeverity) | Adds the specified message to the IIS Transform Manager configuration using the specified severity value. (Inherited from ConfigurationBase.) |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
RemoveRestartWarningMessage | Removes the restart warning message from the IIS Transform Manager configuration. (Inherited from ConfigurationBase.) |
|
Save | Saves member variables to an XML file. |
.gif "Static member") |
SetJobTemplates | Sets or refreshes the job template collection. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
ToString | (Inherited from Object.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") |
CredentialIdAttributeName | Represents a constant that is used when the id attribute of the credential element is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
JobTemplateIdAttributeName | Represents a constant that is used when the job template id attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerCpuCores | Represents a constant that is used when an HPC scheduling cores element is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerCpuNodes | Represents a constant that is used when an HPC scheduling nodes element is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerCpusAttributeName | Represents a constant that is used when the scheduler cpus attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerCpuSockets | Represents a constant that is used when an HPC scheduling CPU sockets element is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerIdAttributeName | Represents a constant that is used when the scheduler id attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerMemoryAttributeName | Represents a constant that is used when the scheduler memory attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerNodeGroupsAttributeName | Represents a constant that is used when the scheduler nodeGroups attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
SchedulerUseNodeProfileAttributeName | Represents a constant that is used when the scheduler useNodeProfile attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
|
TaskIdAttributeName | Represents a constant that is used when the task id attribute is assigned to a job definition. This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code. |
Top
Remarks
A job definition maps three pieces of data: a job template, a scheduler, and a watch folder. A JobManager object creates jobs based on the job definition. The JobDefinition object maps JobTemplate objects to FileSystemWatcher objects. The FileSystemWatcher object monitors a folder for jobs. When a file that matches a filter arrives in the watch folder, the JobManager object uses the job template to create a set of tasks on the job scheduler and then dispatches the job.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.