Skip to main content

Class: RespondActivityTaskCompletedByIdRequest

workflowservice.v1.RespondActivityTaskCompletedByIdRequest

Represents a RespondActivityTaskCompletedByIdRequest.

Properties​

activityId​

• activityId: string

Id of the activity to complete


identity​

• identity: string

The identity of the worker/client


namespace​

• namespace: string

Namespace of the workflow which scheduled this activity


resourceId​

• resourceId: string

Resource ID for routing. Contains "workflow:workflow_id" or "activity:activity_id" for standalone activities.


result​

• Optional result: null | $Properties

The serialized result of activity execution


runId​

• runId: string

For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.


workflowId​

• workflowId: string

Id of the workflow which scheduled this activity, leave empty to target a standalone activity

Methods​

toJSON​

▸ toJSON(): Object

Converts this RespondActivityTaskCompletedByIdRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): RespondActivityTaskCompletedByIdRequest & $Properties

Creates a new RespondActivityTaskCompletedByIdRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

RespondActivityTaskCompletedByIdRequest & $Properties

RespondActivityTaskCompletedByIdRequest instance

▸ create(properties?): RespondActivityTaskCompletedByIdRequest

Parameters​

NameType
properties?$Properties

Returns​

RespondActivityTaskCompletedByIdRequest


decode​

▸ decode(reader, length?): RespondActivityTaskCompletedByIdRequest & $Properties

Decodes a RespondActivityTaskCompletedByIdRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

RespondActivityTaskCompletedByIdRequest & $Properties

RespondActivityTaskCompletedByIdRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): RespondActivityTaskCompletedByIdRequest & $Properties

Decodes a RespondActivityTaskCompletedByIdRequest message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

RespondActivityTaskCompletedByIdRequest & $Properties

RespondActivityTaskCompletedByIdRequest

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 RespondActivityTaskCompletedByIdRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskCompletedByIdRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesRespondActivityTaskCompletedByIdRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified RespondActivityTaskCompletedByIdRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskCompletedByIdRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesRespondActivityTaskCompletedByIdRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): RespondActivityTaskCompletedByIdRequest

Creates a RespondActivityTaskCompletedByIdRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

RespondActivityTaskCompletedByIdRequest

RespondActivityTaskCompletedByIdRequest


toObject​

▸ toObject(message, options?): Object

Creates a plain object from a RespondActivityTaskCompletedByIdRequest message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageRespondActivityTaskCompletedByIdRequestRespondActivityTaskCompletedByIdRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object