Class: ActivityTaskStartedEventAttributes
history.v1.ActivityTaskStartedEventAttributes
Represents an ActivityTaskStartedEventAttributes.
Implements
Constructors
constructor
• new ActivityTaskStartedEventAttributes(properties?): ActivityTaskStartedEventAttributes
Constructs a new ActivityTaskStartedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityTaskStartedEventAttributes | Properties to set |
Returns
ActivityTaskStartedEventAttributes
Properties
attempt
• attempt: number
Starting at 1, the number of times this task has been attempted
Implementation of
IActivityTaskStartedEventAttributes.attempt
buildIdRedirectCounter
• buildIdRedirectCounter: Long
Used by server internally to properly reapply build ID redirects to an execution when rebuilding it from events. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
Implementation of
IActivityTaskStartedEventAttributes.buildIdRedirectCounter
identity
• identity: string
id of the worker that picked up this task
Implementation of
IActivityTaskStartedEventAttributes.identity
lastFailure
• Optional lastFailure: null | IFailure
Will be set to the most recent failure details, if this task has previously failed and then been retried.
Implementation of
IActivityTaskStartedEventAttributes.lastFailure
requestId
• requestId: string
This field is populated from the RecordActivityTaskStartedRequest. Matching service would set the request_id on the RecordActivityTaskStartedRequest to a new UUID. This is useful in case a RecordActivityTaskStarted call succeed but matching doesn't get that response, so matching could retry and history service would return success if the request_id matches. In that case, matching will continue to deliver the task to worker. Without this field, history service would return AlreadyStarted error, and matching would drop the task.
Implementation of
IActivityTaskStartedEventAttributes.requestId
scheduledEventId
• scheduledEventId: Long
The id of the ACTIVITY_TASK_SCHEDULED event this task corresponds to
Implementation of
IActivityTaskStartedEventAttributes.scheduledEventId
workerVersion
• Optional workerVersion: null | IWorkerVersionStamp
Version info of the worker to whom this task was dispatched. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
Implementation of
IActivityTaskStartedEventAttributes.workerVersion
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityTaskStartedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ActivityTaskStartedEventAttributes
Creates a new ActivityTaskStartedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityTaskStartedEventAttributes | Properties to set |
Returns
ActivityTaskStartedEventAttributes
ActivityTaskStartedEventAttributes instance
decode
▸ decode(reader, length?): ActivityTaskStartedEventAttributes
Decodes an ActivityTaskStartedEventAttributes message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ActivityTaskStartedEventAttributes
ActivityTaskStartedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityTaskStartedEventAttributes
Decodes an ActivityTaskStartedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityTaskStartedEventAttributes
ActivityTaskStartedEventAttributes
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 ActivityTaskStartedEventAttributes message. Does not implicitly temporal.api.history.v1.ActivityTaskStartedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityTaskStartedEventAttributes | ActivityTaskStartedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityTaskStartedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.ActivityTaskStartedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityTaskStartedEventAttributes | ActivityTaskStartedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityTaskStartedEventAttributes
Creates an ActivityTaskStartedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityTaskStartedEventAttributes
ActivityTaskStartedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ActivityTaskStartedEventAttributes
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ActivityTaskStartedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityTaskStartedEventAttributes | ActivityTaskStartedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object