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: null | $Properties
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
▸ create(properties?): SchedulePatch & $Properties
Creates a new SchedulePatch instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
SchedulePatch instance
▸ create(properties?): SchedulePatch
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): SchedulePatch & $Properties
Decodes a SchedulePatch 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
SchedulePatch
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SchedulePatch & $Properties
Decodes a SchedulePatch message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SchedulePatch
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 SchedulePatch message. Does not implicitly temporal.api.schedule.v1.SchedulePatch.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SchedulePatch message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SchedulePatch message, length delimited. Does not implicitly temporal.api.schedule.v1.SchedulePatch.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SchedulePatch message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SchedulePatch
Creates a SchedulePatch message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SchedulePatch
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SchedulePatch message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SchedulePatch | SchedulePatch |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object