Class: ActivityTaskScheduledEventAttributes
Represents an ActivityTaskScheduledEventAttributes.
Properties
activityId
activityId:
string
The worker/user assigned identifier for the activity
activityType?
optionalactivityType?:$Properties|null
ActivityTaskScheduledEventAttributes activityType.
header?
optionalheader?:$Properties|null
ActivityTaskScheduledEventAttributes header.
heartbeatTimeout?
optionalheartbeatTimeout?:$Properties|null
Maximum permitted time between successful worker heartbeats.
input?
optionalinput?:$Properties|null
ActivityTaskScheduledEventAttributes input.
priority?
optionalpriority?:$Properties|null
Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.
retryPolicy?
optionalretryPolicy?:$Properties|null
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.
scheduleToCloseTimeout?
optionalscheduleToCloseTimeout?:$Properties|null
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. --)
scheduleToStartTimeout?
optionalscheduleToStartTimeout?:$Properties|null
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. --)
startToCloseTimeout?
optionalstartToCloseTimeout?:$Properties|null
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. --)
taskQueue?
optionaltaskQueue?:$Properties|null
ActivityTaskScheduledEventAttributes 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. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
workflowTaskCompletedEventId
workflowTaskCompletedEventId:
Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Methods
toJSON()
toJSON():
object
Converts this ActivityTaskScheduledEventAttributes to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):ActivityTaskScheduledEventAttributes&$Properties
Creates a new ActivityTaskScheduledEventAttributes instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ActivityTaskScheduledEventAttributes & $Properties
ActivityTaskScheduledEventAttributes instance
Call Signature
staticcreate(properties?):ActivityTaskScheduledEventAttributes
Creates a new ActivityTaskScheduledEventAttributes instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ActivityTaskScheduledEventAttributes
ActivityTaskScheduledEventAttributes instance
decode()
staticdecode(reader,length?):ActivityTaskScheduledEventAttributes&$Properties
Decodes an ActivityTaskScheduledEventAttributes message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
ActivityTaskScheduledEventAttributes & $Properties
ActivityTaskScheduledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):ActivityTaskScheduledEventAttributes&$Properties
Decodes an ActivityTaskScheduledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
ActivityTaskScheduledEventAttributes & $Properties
ActivityTaskScheduledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified ActivityTaskScheduledEventAttributes message. Does not implicitly temporal.api.history.v1.ActivityTaskScheduledEventAttributes.verify|verify messages.
Parameters
message
ActivityTaskScheduledEventAttributes message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified ActivityTaskScheduledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.ActivityTaskScheduledEventAttributes.verify|verify messages.
Parameters
message
ActivityTaskScheduledEventAttributes message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):ActivityTaskScheduledEventAttributes
Creates an ActivityTaskScheduledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
ActivityTaskScheduledEventAttributes
ActivityTaskScheduledEventAttributes
toObject()
statictoObject(message,options?):object
Creates a plain object from an ActivityTaskScheduledEventAttributes message. Also converts values to other types if specified.
Parameters
message
ActivityTaskScheduledEventAttributes
ActivityTaskScheduledEventAttributes
options?
IConversionOptions
Conversion options
Returns
object
Plain object