Skip to main content

Interface: IUpdateScheduleRequest

workflowservice.v1.IUpdateScheduleRequest

Properties of an UpdateScheduleRequest.

Hierarchy​

Properties​

conflictToken​

• Optional conflictToken: null | Uint8Array

This can be the value of conflict_token from a DescribeScheduleResponse, which will cause this request to fail if the schedule has been modified between the Describe and this Update. If missing, the schedule will be updated unconditionally.

Inherited from​

$Properties.conflictToken

identity​

• Optional identity: null | string

The identity of the client who initiated this request.

Inherited from​

$Properties.identity

memo​

• Optional memo: null | $Properties

Schedule memo to replace. If set, replaces the entire memo. Do not set this field if you do not want to update the memo. A non-null empty object will clear the memo.

Inherited from​

$Properties.memo

namespace​

• Optional namespace: null | string

The namespace of the schedule to update.

Inherited from​

$Properties.namespace

requestId​

• Optional requestId: null | string

A unique identifier for this update request for idempotence. Typically UUIDv4.

Inherited from​

$Properties.requestId

schedule​

• Optional schedule: null | $Properties

The new schedule. The four main fields of the schedule (spec, action, policies, state) are replaced completely by the values in this message.

Inherited from​

$Properties.schedule

scheduleId​

• Optional scheduleId: null | string

The id of the schedule to update.

Inherited from​

$Properties.scheduleId

searchAttributes​

• Optional searchAttributes: null | $Properties

Schedule search attributes to be updated. Do not set this field if you do not want to update the search attributes. A non-null empty object will set the search attributes to an empty map. Note: you cannot only update the search attributes with UpdateScheduleRequest, you must also set the schedule field; otherwise, it will unset the schedule.

Inherited from​

$Properties.searchAttributes