Skip to main content

Class: SchedulePolicies

Represents a SchedulePolicies.

Properties​

catchupWindow?​

optional catchupWindow?: $Properties | null

Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time. This value defaults to one year, and can't be less than 10 seconds.

keepOriginalWorkflowId​

keepOriginalWorkflowId: boolean

If true, and the action would start a workflow, a timestamp will not be appended to the scheduled workflow id.

overlapPolicy​

overlapPolicy: ScheduleOverlapPolicy

Policy for overlaps. Note that this can be changed after a schedule has taken some actions, and some changes might produce unintuitive results. In general, the later policy overrides the earlier policy.

pauseOnFailure​

pauseOnFailure: boolean

If true, and a workflow run fails or times out, turn on "paused". This applies after retry policies: the full chain of retries must fail to trigger a pause here.

Methods​

toJSON()​

toJSON(): object

Converts this SchedulePolicies to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SchedulePolicies & $Properties

Creates a new SchedulePolicies instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SchedulePolicies & $Properties

SchedulePolicies instance

Call Signature​

static create(properties?): SchedulePolicies

Creates a new SchedulePolicies instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SchedulePolicies

SchedulePolicies instance

decode()​

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

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

SchedulePolicies & $Properties

SchedulePolicies

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SchedulePolicies & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SchedulePolicies & $Properties

SchedulePolicies

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

Parameters​

message​

$Properties

SchedulePolicies message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SchedulePolicies message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SchedulePolicies

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

Parameters​

object​

Plain object

Returns​

SchedulePolicies

SchedulePolicies

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SchedulePolicies

SchedulePolicies

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object