Class: BatchOperationTriggerWorkflowRule
batch.v1.BatchOperationTriggerWorkflowRule
BatchOperationTriggerWorkflowRule sends TriggerWorkflowRule requests to batch workflows.
Implements
Constructors
constructor
• new BatchOperationTriggerWorkflowRule(properties?): BatchOperationTriggerWorkflowRule
Constructs a new BatchOperationTriggerWorkflowRule.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationTriggerWorkflowRule | Properties to set |
Returns
BatchOperationTriggerWorkflowRule
Properties
id
• Optional id: null | string
ID of existing rule.
Implementation of
IBatchOperationTriggerWorkflowRule.id
identity
• identity: string
The identity of the worker/client.
Implementation of
IBatchOperationTriggerWorkflowRule.identity
rule
• Optional rule: "id" | "spec"
BatchOperationTriggerWorkflowRule rule.
spec
• Optional spec: null | IWorkflowRuleSpec
Rule specification to be applied to the workflow without creating a new rule.
Implementation of
IBatchOperationTriggerWorkflowRule.spec
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationTriggerWorkflowRule to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationTriggerWorkflowRule
Creates a new BatchOperationTriggerWorkflowRule instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationTriggerWorkflowRule | Properties to set |
Returns
BatchOperationTriggerWorkflowRule
BatchOperationTriggerWorkflowRule instance
decode
▸ decode(reader, length?): BatchOperationTriggerWorkflowRule
Decodes a BatchOperationTriggerWorkflowRule 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
BatchOperationTriggerWorkflowRule
BatchOperationTriggerWorkflowRule
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationTriggerWorkflowRule
Decodes a BatchOperationTriggerWorkflowRule message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationTriggerWorkflowRule
BatchOperationTriggerWorkflowRule
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 BatchOperationTriggerWorkflowRule message. Does not implicitly temporal.api.batch.v1.BatchOperationTriggerWorkflowRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationTriggerWorkflowRule | BatchOperationTriggerWorkflowRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationTriggerWorkflowRule message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationTriggerWorkflowRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationTriggerWorkflowRule | BatchOperationTriggerWorkflowRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationTriggerWorkflowRule
Creates a BatchOperationTriggerWorkflowRule message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationTriggerWorkflowRule
BatchOperationTriggerWorkflowRule
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationTriggerWorkflowRule
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 BatchOperationTriggerWorkflowRule message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationTriggerWorkflowRule | BatchOperationTriggerWorkflowRule |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object