Class: WorkflowRuleAction
Represents a WorkflowRuleAction.
Implements
Constructors
constructor
• new WorkflowRuleAction(properties?): WorkflowRuleAction
Constructs a new WorkflowRuleAction.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowRuleAction | Properties to set |
Returns
Properties
activityPause
• Optional activityPause: null | IActionActivityPause
WorkflowRuleAction activityPause.
Implementation of
IWorkflowRuleAction.activityPause
variant
• Optional variant: "activityPause"
Supported actions.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowRuleAction to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowRuleAction
Creates a new WorkflowRuleAction instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowRuleAction | Properties to set |
Returns
WorkflowRuleAction instance
decode
▸ decode(reader, length?): WorkflowRuleAction
Decodes a WorkflowRuleAction 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
WorkflowRuleAction
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowRuleAction
Decodes a WorkflowRuleAction message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowRuleAction
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 WorkflowRuleAction message. Does not implicitly temporal.api.rules.v1.WorkflowRuleAction.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowRuleAction | WorkflowRuleAction message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowRuleAction message, length delimited. Does not implicitly temporal.api.rules.v1.WorkflowRuleAction.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowRuleAction | WorkflowRuleAction message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowRuleAction
Creates a WorkflowRuleAction message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowRuleAction
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowRuleAction
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 WorkflowRuleAction message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowRuleAction | WorkflowRuleAction |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object