Class: RespondActivityTaskCanceledByIdRequest
workflowservice.v1.RespondActivityTaskCanceledByIdRequest
Represents a RespondActivityTaskCanceledByIdRequest.
Implements
Constructors
constructor
• new RespondActivityTaskCanceledByIdRequest(properties?): RespondActivityTaskCanceledByIdRequest
Constructs a new RespondActivityTaskCanceledByIdRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondActivityTaskCanceledByIdRequest | Properties to set |
Returns
RespondActivityTaskCanceledByIdRequest
Properties
activityId
• activityId: string
Id of the activity to confirm is cancelled
Implementation of
IRespondActivityTaskCanceledByIdRequest.activityId
details
• Optional details: null | IPayloads
Serialized additional information to attach to the cancellation
Implementation of
IRespondActivityTaskCanceledByIdRequest.details
identity
• identity: string
The identity of the worker/client
Implementation of
IRespondActivityTaskCanceledByIdRequest.identity
namespace
• namespace: string
Namespace of the workflow which scheduled this activity
Implementation of
IRespondActivityTaskCanceledByIdRequest.namespace
runId
• runId: string
Run Id of the workflow which scheduled this activity
Implementation of
IRespondActivityTaskCanceledByIdRequest.runId
workflowId
• workflowId: string
Id of the workflow which scheduled this activity
Implementation of
IRespondActivityTaskCanceledByIdRequest.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this RespondActivityTaskCanceledByIdRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RespondActivityTaskCanceledByIdRequest
Creates a new RespondActivityTaskCanceledByIdRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondActivityTaskCanceledByIdRequest | Properties to set |
Returns
RespondActivityTaskCanceledByIdRequest
RespondActivityTaskCanceledByIdRequest instance
decode
▸ decode(reader, length?): RespondActivityTaskCanceledByIdRequest
Decodes a RespondActivityTaskCanceledByIdRequest 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
RespondActivityTaskCanceledByIdRequest
RespondActivityTaskCanceledByIdRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RespondActivityTaskCanceledByIdRequest
Decodes a RespondActivityTaskCanceledByIdRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RespondActivityTaskCanceledByIdRequest
RespondActivityTaskCanceledByIdRequest
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 RespondActivityTaskCanceledByIdRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskCanceledByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRespondActivityTaskCanceledByIdRequest | RespondActivityTaskCanceledByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RespondActivityTaskCanceledByIdRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskCanceledByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRespondActivityTaskCanceledByIdRequest | RespondActivityTaskCanceledByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RespondActivityTaskCanceledByIdRequest
Creates a RespondActivityTaskCanceledByIdRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RespondActivityTaskCanceledByIdRequest
RespondActivityTaskCanceledByIdRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RespondActivityTaskCanceledByIdRequest
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 RespondActivityTaskCanceledByIdRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RespondActivityTaskCanceledByIdRequest | RespondActivityTaskCanceledByIdRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object