Class: DeleteWorkflowExecutionRequest
workflowservice.v1.DeleteWorkflowExecutionRequest
(-- api-linter: core::0135::request-unknown-fields=disabled aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --) (-- api-linter: core::0135::request-name-required=disabled aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
Implements
Constructors
constructor
• new DeleteWorkflowExecutionRequest(properties?): DeleteWorkflowExecutionRequest
Constructs a new DeleteWorkflowExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteWorkflowExecutionRequest | Properties to set |
Returns
DeleteWorkflowExecutionRequest
Properties
namespace
• namespace: string
DeleteWorkflowExecutionRequest namespace.
Implementation of
IDeleteWorkflowExecutionRequest.namespace
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
Workflow Execution to delete. If run_id is not specified, the latest one is used.
Implementation of
IDeleteWorkflowExecutionRequest.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this DeleteWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeleteWorkflowExecutionRequest
Creates a new DeleteWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteWorkflowExecutionRequest | Properties to set |
Returns
DeleteWorkflowExecutionRequest
DeleteWorkflowExecutionRequest instance
decode
▸ decode(reader, length?): DeleteWorkflowExecutionRequest
Decodes a DeleteWorkflowExecutionRequest 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
DeleteWorkflowExecutionRequest
DeleteWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteWorkflowExecutionRequest
Decodes a DeleteWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeleteWorkflowExecutionRequest
DeleteWorkflowExecutionRequest
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 DeleteWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteWorkflowExecutionRequest | DeleteWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeleteWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteWorkflowExecutionRequest | DeleteWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeleteWorkflowExecutionRequest
Creates a DeleteWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeleteWorkflowExecutionRequest
DeleteWorkflowExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeleteWorkflowExecutionRequest
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 DeleteWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeleteWorkflowExecutionRequest | DeleteWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object