Class: WorkflowRule
WorkflowRule describes a rule that can be applied to any workflow in this namespace.
Implements
Constructors
constructor
• new WorkflowRule(properties?): WorkflowRule
Constructs a new WorkflowRule.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowRule | Properties to set |
Returns
Properties
createTime
• Optional createTime: null | ITimestamp
Rule creation time.
Implementation of
createdByIdentity
• createdByIdentity: string
Identity of the actor that created the rule (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: It is better reflect the intent this way, we will also have updated_by. --) (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Same as above. All other options sounds clumsy --)
Implementation of
IWorkflowRule.createdByIdentity
description
• description: string
Rule description.
Implementation of
spec
• Optional spec: null | IWorkflowRuleSpec
Rule specification
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowRule to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowRule
Creates a new WorkflowRule instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowRule | Properties to set |
Returns
WorkflowRule instance
decode
▸ decode(reader, length?): WorkflowRule
Decodes a WorkflowRule 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
WorkflowRule
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowRule
Decodes a WorkflowRule message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowRule
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 WorkflowRule message. Does not implicitly temporal.api.rules.v1.WorkflowRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowRule | WorkflowRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowRule message, length delimited. Does not implicitly temporal.api.rules.v1.WorkflowRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowRule | WorkflowRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowRule
Creates a WorkflowRule message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowRule
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowRule
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 WorkflowRule message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowRule | WorkflowRule |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object