Class: DescribeWorkflowRuleRequest
workflowservice.v1.DescribeWorkflowRuleRequest
Represents a DescribeWorkflowRuleRequest.
Properties
namespace
• namespace: string
DescribeWorkflowRuleRequest namespace.
ruleId
• ruleId: string
User-specified ID of the rule to read. Unique within the namespace.
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeWorkflowRuleRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeWorkflowRuleRequest & $Properties
Creates a new DescribeWorkflowRuleRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DescribeWorkflowRuleRequest & $Properties
DescribeWorkflowRuleRequest instance
▸ create(properties?): DescribeWorkflowRuleRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DescribeWorkflowRuleRequest & $Properties
Decodes a DescribeWorkflowRuleRequest 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
DescribeWorkflowRuleRequest & $Properties
DescribeWorkflowRuleRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeWorkflowRuleRequest & $Properties
Decodes a DescribeWorkflowRuleRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeWorkflowRuleRequest & $Properties
DescribeWorkflowRuleRequest
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 DescribeWorkflowRuleRequest message. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkflowRuleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeWorkflowRuleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeWorkflowRuleRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkflowRuleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeWorkflowRuleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeWorkflowRuleRequest
Creates a DescribeWorkflowRuleRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeWorkflowRuleRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeWorkflowRuleRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeWorkflowRuleRequest | DescribeWorkflowRuleRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object