Class: RespondActivityTaskCompletedRequest
workflowservice.v1.RespondActivityTaskCompletedRequest
Represents a RespondActivityTaskCompletedRequest.
Implements
Constructors
constructor
• new RespondActivityTaskCompletedRequest(properties?): RespondActivityTaskCompletedRequest
Constructs a new RespondActivityTaskCompletedRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondActivityTaskCompletedRequest | Properties to set |
Returns
RespondActivityTaskCompletedRequest
Properties
deployment
• Optional deployment: null | IDeployment
Deployment info of the worker that completed this task. Must be present if user has set
WorkerDeploymentOptions regardless of versioning being enabled or not.
Deprecated. Replaced with deployment_options.
Implementation of
IRespondActivityTaskCompletedRequest.deployment
deploymentOptions
• Optional deploymentOptions: null | IWorkerDeploymentOptions
Worker deployment options that user has set in the worker.
Implementation of
IRespondActivityTaskCompletedRequest.deploymentOptions
identity
• identity: string
The identity of the worker/client
Implementation of
IRespondActivityTaskCompletedRequest.identity
namespace
• namespace: string
RespondActivityTaskCompletedRequest namespace.
Implementation of
IRespondActivityTaskCompletedRequest.namespace
resourceId
• resourceId: string
Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.
Implementation of
IRespondActivityTaskCompletedRequest.resourceId
result
• Optional result: null | IPayloads
The result of successfully executing the activity
Implementation of
IRespondActivityTaskCompletedRequest.result
taskToken
• taskToken: Uint8Array
The task token as received in PollActivityTaskQueueResponse
Implementation of
IRespondActivityTaskCompletedRequest.taskToken
workerVersion
• Optional workerVersion: null | IWorkerVersionStamp
Version info of the worker who processed this task. This message's build_id field should
always be set by SDKs. Workers opting into versioning will also set the use_versioning
field to true. See message docstrings for more.
Deprecated. Use deployment_options instead.
Implementation of
IRespondActivityTaskCompletedRequest.workerVersion
Methods
toJSON
▸ toJSON(): Object
Converts this RespondActivityTaskCompletedRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RespondActivityTaskCompletedRequest
Creates a new RespondActivityTaskCompletedRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondActivityTaskCompletedRequest | Properties to set |
Returns
RespondActivityTaskCompletedRequest
RespondActivityTaskCompletedRequest instance
decode
▸ decode(reader, length?): RespondActivityTaskCompletedRequest
Decodes a RespondActivityTaskCompletedRequest 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
RespondActivityTaskCompletedRequest
RespondActivityTaskCompletedRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RespondActivityTaskCompletedRequest
Decodes a RespondActivityTaskCompletedRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RespondActivityTaskCompletedRequest
RespondActivityTaskCompletedRequest
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 RespondActivityTaskCompletedRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskCompletedRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRespondActivityTaskCompletedRequest | RespondActivityTaskCompletedRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RespondActivityTaskCompletedRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskCompletedRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRespondActivityTaskCompletedRequest | RespondActivityTaskCompletedRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RespondActivityTaskCompletedRequest
Creates a RespondActivityTaskCompletedRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RespondActivityTaskCompletedRequest
RespondActivityTaskCompletedRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RespondActivityTaskCompletedRequest
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 RespondActivityTaskCompletedRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RespondActivityTaskCompletedRequest | RespondActivityTaskCompletedRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object