Skip to main content

Class: ScheduleAction

Represents a ScheduleAction.

Properties​

action?​

optional action?: "startWorkflow"

ScheduleAction action.

startWorkflow?​

optional startWorkflow?: $Properties | null

All fields of NewWorkflowExecutionInfo are valid except for:

  • workflow_id_reuse_policy
  • cron_schedule The workflow id of the started workflow may not match this exactly, it may have a timestamp appended for uniqueness.

Methods​

toJSON()​

toJSON(): object

Converts this ScheduleAction to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScheduleAction & $Shape

Creates a new ScheduleAction instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ScheduleAction & $Shape

ScheduleAction instance

Call Signature​

static create(properties?): ScheduleAction

Creates a new ScheduleAction instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleAction

ScheduleAction instance

decode()​

static decode(reader, length?): ScheduleAction & $Shape

Decodes a ScheduleAction message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ScheduleAction & $Shape

ScheduleAction

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScheduleAction & $Shape

Decodes a ScheduleAction message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScheduleAction & $Shape

ScheduleAction

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ScheduleAction message. Does not implicitly temporal.api.schedule.v1.ScheduleAction.verify|verify messages.

Parameters​

message​

$Properties

ScheduleAction message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ScheduleAction message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleAction.verify|verify messages.

Parameters​

message​

$Properties

ScheduleAction message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScheduleAction

Creates a ScheduleAction message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

ScheduleAction

ScheduleAction

toObject()​

static toObject(message, options?): object

Creates a plain object from a ScheduleAction message. Also converts values to other types if specified.

Parameters​

message​

ScheduleAction

ScheduleAction

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object