Class: SchedulePatch
Represents a SchedulePatch.
Implements
Constructors
constructor
• new SchedulePatch(properties?): SchedulePatch
Constructs a new SchedulePatch.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISchedulePatch | Properties to set |
Returns
Properties
backfillRequest
• backfillRequest: IBackfillRequest[]
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.
Implementation of
ISchedulePatch.backfillRequest
pause
• pause: string
If set, change the state to paused or unpaused (respectively) and set the notes field to the value of the string.
Implementation of
triggerImmediately
• Optional triggerImmediately: null | ITriggerImmediatelyRequest
If set, trigger one action immediately.
Implementation of
ISchedulePatch.triggerImmediately
unpause
• unpause: string
SchedulePatch unpause.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this SchedulePatch to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SchedulePatch
Creates a new SchedulePatch instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISchedulePatch | Properties to set |
Returns
SchedulePatch instance
decode
▸ decode(reader, length?): SchedulePatch
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
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 | ISchedulePatch | 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 | ISchedulePatch | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SchedulePatch
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 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