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