Skip to main content

Class: Schedule

Represents a Schedule.

Properties​

action?​

optional action?: $Properties | null

Schedule action.

policies?​

optional policies?: $Properties | null

Schedule policies.

spec?​

optional spec?: $Properties | null

Schedule spec.

state?​

optional state?: $Properties | null

Schedule state.

Methods​

toJSON()​

toJSON(): object

Converts this Schedule to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Schedule & $Shape

Creates a new Schedule instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Schedule & $Shape

Schedule instance

Call Signature​

static create(properties?): Schedule

Creates a new Schedule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Schedule

Schedule instance

decode()​

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

Decodes a Schedule 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​

Schedule & $Shape

Schedule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Schedule & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Schedule & $Shape

Schedule

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 Schedule message. Does not implicitly temporal.api.schedule.v1.Schedule.verify|verify messages.

Parameters​

message​

$Properties

Schedule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Schedule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Schedule

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

Parameters​

object​

Plain object

Returns​

Schedule

Schedule

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Schedule

Schedule

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object