Class: SchedulePolicies
Represents a SchedulePolicies.
Implements
Constructors
constructor
• new SchedulePolicies(properties?): SchedulePolicies
Constructs a new SchedulePolicies.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISchedulePolicies | Properties to set |
Returns
Properties
catchupWindow
• Optional catchupWindow: null | IDuration
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.
Implementation of
ISchedulePolicies.catchupWindow
keepOriginalWorkflowId
• keepOriginalWorkflowId: boolean
If true, and the action would start a workflow, a timestamp will not be appended to the scheduled workflow id.
Implementation of
ISchedulePolicies.keepOriginalWorkflowId
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.
Implementation of
ISchedulePolicies.overlapPolicy
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.
Implementation of
ISchedulePolicies.pauseOnFailure
Methods
toJSON
▸ toJSON(): Object
Converts this SchedulePolicies to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SchedulePolicies
Creates a new SchedulePolicies instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISchedulePolicies | Properties to set |
Returns
SchedulePolicies instance
decode
▸ decode(reader, length?): SchedulePolicies
Decodes a SchedulePolicies message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
SchedulePolicies
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SchedulePolicies
Decodes a SchedulePolicies message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SchedulePolicies
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified SchedulePolicies message. Does not implicitly temporal.api.schedule.v1.SchedulePolicies.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISchedulePolicies | SchedulePolicies message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SchedulePolicies message, length delimited. Does not implicitly temporal.api.schedule.v1.SchedulePolicies.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISchedulePolicies | SchedulePolicies message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SchedulePolicies
Creates a SchedulePolicies message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SchedulePolicies
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SchedulePolicies
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SchedulePolicies message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SchedulePolicies | SchedulePolicies |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object