BatchJobSchedule interface
A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.
Properties
| creation |
The creation time of the Job Schedule. |
| display |
The display name for the schedule. |
| e |
The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime. |
| execution |
Information about Jobs that have been and will be run under this schedule. |
| id | A string that uniquely identifies the schedule within the Account. |
| job |
The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. |
| job |
The details of the Jobs to be created on this schedule. |
| last |
The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state. |
| metadata | A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
| previous |
The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. |
| previous |
The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state. |
| schedule | The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. |
| state | The current state of the Job Schedule. |
| state |
The time at which the Job Schedule entered the current state. |
| url | The URL of the Job Schedule. |
Property Details
creationTime
The creation time of the Job Schedule.
creationTime: DateProperty Value
Date
displayName
The display name for the schedule.
displayName?: stringProperty Value
string
eTag
The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.
eTag: stringProperty Value
string
executionInfo
Information about Jobs that have been and will be run under this schedule.
executionInfo: BatchJobScheduleExecutionInfoProperty Value
id
A string that uniquely identifies the schedule within the Account.
id: stringProperty Value
string
jobScheduleStatistics
The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
jobScheduleStatistics?: BatchJobScheduleStatisticsProperty Value
jobSpecification
The details of the Jobs to be created on this schedule.
jobSpecification: BatchJobSpecificationProperty Value
lastModified
The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.
lastModified: DateProperty Value
Date
metadata
A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
metadata?: BatchMetadataItem[]Property Value
previousState
The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state.
previousState?: BatchJobScheduleStateProperty Value
previousStateTransitionTime
The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state.
previousStateTransitionTime?: DateProperty Value
Date
schedule
The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.
schedule?: BatchJobScheduleConfigurationProperty Value
state
The current state of the Job Schedule.
state: BatchJobScheduleStateProperty Value
stateTransitionTime
The time at which the Job Schedule entered the current state.
stateTransitionTime: DateProperty Value
Date
url
The URL of the Job Schedule.
url: stringProperty Value
string