Skip to main content

Class: PollActivityTaskQueueRequest

workflowservice.v1.PollActivityTaskQueueRequest

Represents a PollActivityTaskQueueRequest.

Implements

Constructors

constructor

new PollActivityTaskQueueRequest(properties?): PollActivityTaskQueueRequest

Constructs a new PollActivityTaskQueueRequest.

Parameters

NameTypeDescription
properties?IPollActivityTaskQueueRequestProperties to set

Returns

PollActivityTaskQueueRequest

Properties

identity

identity: string

The identity of the worker/client

Implementation of

IPollActivityTaskQueueRequest.identity


namespace

namespace: string

PollActivityTaskQueueRequest namespace.

Implementation of

IPollActivityTaskQueueRequest.namespace


taskQueue

Optional taskQueue: null | ITaskQueue

PollActivityTaskQueueRequest taskQueue.

Implementation of

IPollActivityTaskQueueRequest.taskQueue


taskQueueMetadata

Optional taskQueueMetadata: null | ITaskQueueMetadata

PollActivityTaskQueueRequest taskQueueMetadata.

Implementation of

IPollActivityTaskQueueRequest.taskQueueMetadata


workerVersionCapabilities

Optional workerVersionCapabilities: null | IWorkerVersionCapabilities

Information about this worker's build identifier and if it is choosing to use the versioning feature. See the WorkerVersionCapabilities docstring for more.

Implementation of

IPollActivityTaskQueueRequest.workerVersionCapabilities

Methods

toJSON

toJSON(): Object

Converts this PollActivityTaskQueueRequest to JSON.

Returns

Object

JSON object


create

create(properties?): PollActivityTaskQueueRequest

Creates a new PollActivityTaskQueueRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IPollActivityTaskQueueRequestProperties to set

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest instance


decode

decode(reader, length?): PollActivityTaskQueueRequest

Decodes a PollActivityTaskQueueRequest message from the specified reader or buffer.

Parameters

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

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PollActivityTaskQueueRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): PollActivityTaskQueueRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollActivityTaskQueueRequest

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 PollActivityTaskQueueRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messagePollActivityTaskQueueRequestPollActivityTaskQueueRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object