Skip to main content

Class: RespondActivityTaskCanceledRequest

workflowservice.v1.RespondActivityTaskCanceledRequest

Represents a RespondActivityTaskCanceledRequest.

Implements

Constructors

constructor

new RespondActivityTaskCanceledRequest(properties?): RespondActivityTaskCanceledRequest

Constructs a new RespondActivityTaskCanceledRequest.

Parameters

NameTypeDescription
properties?IRespondActivityTaskCanceledRequestProperties to set

Returns

RespondActivityTaskCanceledRequest

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.

Implementation of

IRespondActivityTaskCanceledRequest.deployment


details

Optional details: null | IPayloads

Serialized additional information to attach to the cancellation

Implementation of

IRespondActivityTaskCanceledRequest.details


identity

identity: string

The identity of the worker/client

Implementation of

IRespondActivityTaskCanceledRequest.identity


namespace

namespace: string

RespondActivityTaskCanceledRequest namespace.

Implementation of

IRespondActivityTaskCanceledRequest.namespace


taskToken

taskToken: Uint8Array

The task token as received in PollActivityTaskQueueResponse

Implementation of

IRespondActivityTaskCanceledRequest.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 instead.

Implementation of

IRespondActivityTaskCanceledRequest.workerVersion

Methods

toJSON

toJSON(): Object

Converts this RespondActivityTaskCanceledRequest to JSON.

Returns

Object

JSON object


create

create(properties?): RespondActivityTaskCanceledRequest

Creates a new RespondActivityTaskCanceledRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IRespondActivityTaskCanceledRequestProperties to set

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest instance


decode

decode(reader, length?): RespondActivityTaskCanceledRequest

Decodes a RespondActivityTaskCanceledRequest message from the specified reader or buffer.

Parameters

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

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): RespondActivityTaskCanceledRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest

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

Parameters

NameTypeDescription
messageIRespondActivityTaskCanceledRequestRespondActivityTaskCanceledRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIRespondActivityTaskCanceledRequestRespondActivityTaskCanceledRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): RespondActivityTaskCanceledRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RespondActivityTaskCanceledRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRespondActivityTaskCanceledRequestRespondActivityTaskCanceledRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object