Export (0) Print
Expand All

JobDefinition Class

IIS 7.0

Defines how IIS Transform Manager monitors, creates, schedules, and maintains jobs.

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)

[SerializableAttribute]
[DataContractAttribute]
public class JobDefinition : ConfigurationBase

The JobDefinition type exposes the following members.

  NameDescription
Public methodJobDefinition()()()()Initializes a new instance of the JobDefinition class.
Public methodJobDefinition(FileInfo, XElement)Initializes a new instance of the JobDefinition class using the specified file and job definition information.
Top

  NameDescription
Public propertyAssetRetentionPeriodDisplayUnitGets or sets a value that indicates how long the assets that are associated with a job are retained.
Public propertyAssetRetentionPeriodMinutesGets 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.
Public propertyBaseNamespaceGets or sets the XML namespace for the configuration. (Inherited from ConfigurationBase.)
Public propertyConcurrentJobsGets or sets the number of concurrent jobs that the job manager can start when it uses this job definition.
Public propertyConfigurationDirectoryGets the path of the job definition configuration file.
Public propertyConfigurationMessagesGets or sets a list of IIS Transform Manager configuration messages. (Inherited from ConfigurationBase.)
Public propertyConfigurationMessagesElementGets or sets an XML element that contains configuration messages for the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public propertyConfigurationStatusGets or sets the IIS Transform Manager configuration status. (Inherited from ConfigurationBase.)
Public propertyCredentialIdGets or sets a GUID that identifies the credential that is associated with this job definition.
Public propertyDeleteCanceledFilesGets or sets a value that indicates whether asset files for canceled jobs should be deleted during the maintenance cycle.
Public propertyDeleteFailedFilesGets or sets a value that indicates whether asset files for failed jobs should be deleted during the maintenance cycle.
Public propertyDeleteFinishedFilesGets or sets a value that indicates whether asset files for finished jobs should be deleted during the maintenance cycle.
Public propertyDescriptionGets or sets a description of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public propertyDescriptionElementGets or set the XML element that contains the description of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public propertyEnabledGets or sets a value that indicates whether the job manager that is associated with this job definition can be started.
Public propertyEnforceFileNameCaseGets or sets a value that indicates whether the file names referenced in the manifest must match in case.
Public propertyFileNameGets or sets the name of the configuration file for the current job definition.
Public propertyIdGets or sets the XML element ID of a configuration object. (Inherited from ConfigurationBase.)
Public propertyIdElementGets or sets the XML ID element of a configuration object. (Inherited from ConfigurationBase.)
Public propertyInputFolderGets 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.
Public propertyInputFolderPathGets 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.
Public propertyInputIsManifestGets or sets a value that indicates whether the file that initiates job creation is a SMIL 2.0-compliant manifest.
Public propertyIsJobManagerRunningGets or sets a value that indicates whether the job manager that is associated with this job definition is running.
Public propertyJobManagerLogLevelGets or sets the threshold value of log entries that are written to the job manager log.
Public propertyJobManagerLogRolloverIntervalDisplayUnitGets or sets the unit of time that is used with the JobDefinition..::..JobManagerLogRolloverIntervalMinutes property to indicate when to create a new log.
Public propertyJobManagerLogRolloverIntervalMinutesGets or sets the number of minutes of log data to collect before a new log file is created.
Public propertyLastModifiedGets or sets the date and time when the IIS Transform Manager configuration was last modified. (Inherited from ConfigurationBase.)
Public propertyLocalFileWatcherFilterGets or sets a file filter value that is used to initiate job creation.
Public propertyLogFolder
Public propertyLogFolderNameJobInstances
Public propertyLogFolderWatchFolderManager
Public propertyLogLevelGets 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.)
Public propertyLogLevelElementGets or sets an XML element that contains log level details. (Inherited from ConfigurationBase.)
Public propertyLogRetentionPeriodDisplayUnitGets 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.
Public propertyLogRetentionPeriodMinutesGets or sets the number of minutes that the log that is associated with a job is retained before being deleted during maintenance.
Public propertyMaintenanceCommand
Public propertyMaintenanceIntervalDisplayUnitGets or sets the unit of time that is used with the MaintenanceIntervalMinutes property to indicate how often maintenance is run.
Public propertyMaintenanceIntervalMinutesGets or sets the number of minutes between maintenance-processing activities.
Public propertyMaintenanceTimeGets or sets a fixed time during the day to run maintenance.
Public propertyMaintenanceUseIntervalGets or sets a value that indicates that maintenance should be run at a specified interval instead of at a fixed time.
Public propertyNameGets or sets the XML element name of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public propertyNameElementGets or sets an XML element that contains name details. (Inherited from ConfigurationBase.)
Public propertyNodeTaskCodePathX64Gets or sets a location for x64 binary files.
Public propertyNodeTaskCodePathX86Gets or sets a location for x86 binary files.
Public propertyNotificationIncludeLogForFailedJobGets 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.
Public propertyNotificationsGets or sets a collection of the job notifications that trigger a notification POST request.
Public propertyNotificationUrlGets or sets a URL to which HTTP POST request notifications are sent.
Public propertyOutputFolderGets 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.
Public propertyOutputFolderPathGets 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.
Public propertyPriorityGets or sets the priority of a job.
Public propertyProcessPriority
Public propertySchedulerCpuDisplayUnitGets or sets an HPC CPU unit value.
Public propertySchedulerCpusGets or sets a CPU value based on the scheduler.
Public propertySchedulerIdGets or sets the ID of the scheduler that is associated with this job definition.
Public propertySchedulerMemoryGets or sets a memory value based on the scheduler.
Public propertySchedulerNodeGroupsGets or sets a list of compute nodes.
Public propertySchedulerPropertiesGets a list of additional scheduler properties.
Public propertySchedulerUseNodeProfileGets or sets a value that determines whether the HPC scheduler should use the SchedulerCpus, SchedulerMemory, and SchedulerNodeGroups properties when a job is transformed.
Public propertyTemplateIdGets or sets the ID of the job template that the JobDefinition object uses.
Public propertyTemplateNameGets or sets the name of the job template that the current JobDefinition object uses.
Public propertyWatchFolderGets or sets a file system folder that will be watched for files that will instantiate jobs.
Public propertyWorkFolder
Top

  NameDescription
Public methodAddConfigurationMessage(String)Adds the specified message to the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public methodAddConfigurationMessage(String, ConfigurationMessageSeverity)Adds the specified message to the IIS Transform Manager configuration using the specified severity value. (Inherited from ConfigurationBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRemoveRestartWarningMessageRemoves the restart warning message from the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public methodSaveSaves member variables to an XML file.
Public methodStatic memberSetJobTemplatesSets 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.
Public methodToString (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberCredentialIdAttributeNameRepresents 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.
Public fieldStatic memberJobTemplateIdAttributeNameRepresents 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.
Public fieldStatic memberSchedulerCpuCoresRepresents 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.
Public fieldStatic memberSchedulerCpuNodesRepresents 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.
Public fieldStatic memberSchedulerCpusAttributeNameRepresents 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.
Public fieldStatic memberSchedulerCpuSocketsRepresents 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.
Public fieldStatic memberSchedulerIdAttributeNameRepresents 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.
Public fieldStatic memberSchedulerMemoryAttributeNameRepresents 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.
Public fieldStatic memberSchedulerNodeGroupsAttributeNameRepresents 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.
Public fieldStatic memberSchedulerUseNodeProfileAttributeNameRepresents 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.
Public fieldStatic memberTaskIdAttributeNameRepresents 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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft