Skip to main content

Interface: IDescribeScheduleResponse

workflowservice.v1.IDescribeScheduleResponse

Properties of a DescribeScheduleResponse.

Hierarchy​

Properties​

conflictToken​

• Optional conflictToken: null | Uint8Array

This value can be passed back to UpdateSchedule to ensure that the schedule was not modified between a Describe and an Update, which could lead to lost updates and other confusion.

Inherited from​

$Properties.conflictToken

info​

• Optional info: null | $Properties

Extra schedule state info.

Inherited from​

$Properties.info

memo​

• Optional memo: null | $Properties

The memo and search attributes that the schedule was created with.

Inherited from​

$Properties.memo

schedule​

• Optional schedule: null | $Properties

The complete current schedule details. This may not match the schedule as created because:

  • some types of schedule specs may get compiled into others (e.g. CronString into StructuredCalendarSpec)
  • some unspecified fields may be replaced by defaults
  • some fields in the state are modified automatically
  • the schedule may have been modified by UpdateSchedule or PatchSchedule

Inherited from​

$Properties.schedule

searchAttributes​

• Optional searchAttributes: null | $Properties

DescribeScheduleResponse searchAttributes

Inherited from​

$Properties.searchAttributes