Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JobScheduleAddParameter

Package version

An interface representing JobScheduleAddParameter.

summary

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Hierarchy

  • JobScheduleAddParameter

Index

Properties

Optional displayName

displayName: undefined | string

The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

id

id: string

A string that uniquely identifies the schedule within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

jobSpecification

jobSpecification: JobSpecification

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

Optional metadata

metadata: MetadataItem[]

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.

schedule

schedule: Schedule

The schedule according to which jobs will be created.

Generated using TypeDoc