Skip to main content

Class: ActivityTaskScheduledEventAttributes

history.v1.ActivityTaskScheduledEventAttributes

Represents an ActivityTaskScheduledEventAttributes.

Implements

Constructors

constructor

new ActivityTaskScheduledEventAttributes(properties?): ActivityTaskScheduledEventAttributes

Constructs a new ActivityTaskScheduledEventAttributes.

Parameters

NameTypeDescription
properties?IActivityTaskScheduledEventAttributesProperties to set

Returns

ActivityTaskScheduledEventAttributes

Properties

activityId

activityId: string

The worker/user assigned identifier for the activity

Implementation of

IActivityTaskScheduledEventAttributes.activityId


activityType

Optional activityType: null | IActivityType

ActivityTaskScheduledEventAttributes activityType.

Implementation of

IActivityTaskScheduledEventAttributes.activityType


Optional header: null | IHeader

ActivityTaskScheduledEventAttributes header.

Implementation of

IActivityTaskScheduledEventAttributes.header


heartbeatTimeout

Optional heartbeatTimeout: null | IDuration

Maximum permitted time between successful worker heartbeats.

Implementation of

IActivityTaskScheduledEventAttributes.heartbeatTimeout


input

Optional input: null | IPayloads

ActivityTaskScheduledEventAttributes input.

Implementation of

IActivityTaskScheduledEventAttributes.input


retryPolicy

Optional retryPolicy: null | IRetryPolicy

Activities are assigned a default retry policy controlled by the service's dynamic configuration. Retries will happen up to schedule_to_close_timeout. To disable retries set retry_policy.maximum_attempts to 1.

Implementation of

IActivityTaskScheduledEventAttributes.retryPolicy


scheduleToCloseTimeout

Optional scheduleToCloseTimeout: null | IDuration

Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

Implementation of

IActivityTaskScheduledEventAttributes.scheduleToCloseTimeout


scheduleToStartTimeout

Optional scheduleToStartTimeout: null | IDuration

Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout or workflow execution timeout if not specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

Implementation of

IActivityTaskScheduledEventAttributes.scheduleToStartTimeout


startToCloseTimeout

Optional startToCloseTimeout: null | IDuration

Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or schedule_to_close_timeout must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

Implementation of

IActivityTaskScheduledEventAttributes.startToCloseTimeout


taskQueue

Optional taskQueue: null | ITaskQueue

ActivityTaskScheduledEventAttributes taskQueue.

Implementation of

IActivityTaskScheduledEventAttributes.taskQueue


useWorkflowBuildId

useWorkflowBuildId: boolean

If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise, Assignment rules of the activity's Task Queue will be used to determine the Build ID.

Implementation of

IActivityTaskScheduledEventAttributes.useWorkflowBuildId


workflowTaskCompletedEventId

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Implementation of

IActivityTaskScheduledEventAttributes.workflowTaskCompletedEventId

Methods

toJSON

toJSON(): Object

Converts this ActivityTaskScheduledEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): ActivityTaskScheduledEventAttributes

Creates a new ActivityTaskScheduledEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IActivityTaskScheduledEventAttributesProperties to set

Returns

ActivityTaskScheduledEventAttributes

ActivityTaskScheduledEventAttributes instance


decode

decode(reader, length?): ActivityTaskScheduledEventAttributes

Decodes an ActivityTaskScheduledEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

ActivityTaskScheduledEventAttributes

ActivityTaskScheduledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ActivityTaskScheduledEventAttributes

Decodes an ActivityTaskScheduledEventAttributes message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ActivityTaskScheduledEventAttributes

ActivityTaskScheduledEventAttributes

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ActivityTaskScheduledEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ActivityTaskScheduledEventAttributes

ActivityTaskScheduledEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ActivityTaskScheduledEventAttributes

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

Parameters

NameTypeDescription
messageActivityTaskScheduledEventAttributesActivityTaskScheduledEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object