Skip to main content

Class: SchedulePatch

Represents a SchedulePatch.

Properties​

backfillRequest​

backfillRequest: $Properties[]

If set, runs though the specified time period(s) and takes actions as if that time passed by right now, all at once. The overlap policy can be overridden for the scope of the backfill.

pause​

pause: string

If set, change the state to paused or unpaused (respectively) and set the notes field to the value of the string.

triggerImmediately?​

optional triggerImmediately?: $Properties | null

If set, trigger one action immediately.

unpause​

unpause: string

SchedulePatch unpause.

Methods​

toJSON()​

toJSON(): object

Converts this SchedulePatch to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SchedulePatch & $Properties

Creates a new SchedulePatch instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SchedulePatch & $Properties

SchedulePatch instance

Call Signature​

static create(properties?): SchedulePatch

Creates a new SchedulePatch instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SchedulePatch

SchedulePatch instance

decode()​

static decode(reader, length?): SchedulePatch & $Properties

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

SchedulePatch & $Properties

SchedulePatch

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SchedulePatch & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SchedulePatch & $Properties

SchedulePatch

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

Parameters​

message​

$Properties

SchedulePatch message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SchedulePatch message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SchedulePatch

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

Parameters​

object​

Plain object

Returns​

SchedulePatch

SchedulePatch

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SchedulePatch

SchedulePatch

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object