Documentation

ScheduleDescription
in package

FinalYes

Describes the current Schedule details.

Tags
see
ScheduleHandle::describe()
see
DescribeScheduleResponse

Table of Contents

Properties

$conflictToken  : string
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.
$info  : ScheduleInfo
Extra schedule state info.
$memo  : EncodedCollection
Non-indexed user supplied information.
$schedule  : Schedule
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
$searchAttributes  : EncodedCollection
Additional indexed information used for search and visibility.

Properties

$conflictToken read-only

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.

public string $conflictToken

$schedule read-only

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

public Schedule $schedule

$searchAttributes read-only

Additional indexed information used for search and visibility.

public EncodedCollection $searchAttributes

The key and its value type are registered on Temporal server side Use GetSearchAttributes API to get valid key and corresponding value type. For supported operations on different server versions see .


        
On this page

Search results