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