Share via


CloudJobSchedule interface

An interface representing CloudJobSchedule.

Properties

creationTime

The creation time of the Job Schedule.

displayName

The display name for the schedule.

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.

executionInfo

Information about Jobs that have been and will be run under this schedule.

id

A string that uniquely identifies the schedule within the Account.

jobSpecification

The details of the Jobs to be created on this schedule.

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.

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.

previousState

The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

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.

schedule

The schedule according to which Jobs will be created.

state

The current state of the Job Schedule. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

stateTransitionTime

The time at which the Job Schedule entered the current state.

stats

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.

url

The URL of the Job Schedule.

Property Details

creationTime

The creation time of the Job Schedule.

creationTime?: Date

Property Value

Date

displayName

The display name for the schedule.

displayName?: string

Property 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?: string

Property Value

string

executionInfo

Information about Jobs that have been and will be run under this schedule.

executionInfo?: JobScheduleExecutionInformation

Property Value

id

A string that uniquely identifies the schedule within the Account.

id?: string

Property Value

string

jobSpecification

The details of the Jobs to be created on this schedule.

jobSpecification?: JobSpecification

Property 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?: Date

Property 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?: MetadataItem[]

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. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

previousState?: JobScheduleState

Property 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?: Date

Property Value

Date

schedule

The schedule according to which Jobs will be created.

schedule?: Schedule

Property Value

state

The current state of the Job Schedule. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

state?: JobScheduleState

Property Value

stateTransitionTime

The time at which the Job Schedule entered the current state.

stateTransitionTime?: Date

Property Value

Date

stats

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.

stats?: JobScheduleStatistics

Property Value

url

The URL of the Job Schedule.

url?: string

Property Value

string