Class: WorkflowTaskCompletedEventAttributes
history.v1.WorkflowTaskCompletedEventAttributes
Represents a WorkflowTaskCompletedEventAttributes.
Implements
Constructors
constructor
• new WorkflowTaskCompletedEventAttributes(properties?): WorkflowTaskCompletedEventAttributes
Constructs a new WorkflowTaskCompletedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowTaskCompletedEventAttributes | Properties to set |
Returns
WorkflowTaskCompletedEventAttributes
Properties
binaryChecksum
• binaryChecksum: string
Binary ID of the worker who completed this task
Implementation of
IWorkflowTaskCompletedEventAttributes.binaryChecksum
identity
• identity: string
Identity of the worker who completed this task
Implementation of
IWorkflowTaskCompletedEventAttributes.identity
meteringMetadata
• Optional meteringMetadata: null | IMeteringMetadata
Local usage data sent during workflow task completion and recorded here for posterity
Implementation of
IWorkflowTaskCompletedEventAttributes.meteringMetadata
scheduledEventId
• scheduledEventId: Long
The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to
Implementation of
IWorkflowTaskCompletedEventAttributes.scheduledEventId
sdkMetadata
• Optional sdkMetadata: null | IWorkflowTaskCompletedMetadata
Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.
Implementation of
IWorkflowTaskCompletedEventAttributes.sdkMetadata
startedEventId
• startedEventId: Long
The id of the WORKFLOW_TASK_STARTED event this task corresponds to
Implementation of
IWorkflowTaskCompletedEventAttributes.startedEventId
workerVersion
• Optional workerVersion: null | IWorkerVersionStamp
Version info of the worker who processed this workflow task. If present, the build_id field
within is also used as binary_checksum, which may be omitted in that case (it may also be
populated to preserve compatibility).
Implementation of
IWorkflowTaskCompletedEventAttributes.workerVersion
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowTaskCompletedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowTaskCompletedEventAttributes
Creates a new WorkflowTaskCompletedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowTaskCompletedEventAttributes | Properties to set |
Returns
WorkflowTaskCompletedEventAttributes
WorkflowTaskCompletedEventAttributes instance
decode
▸ decode(reader, length?): WorkflowTaskCompletedEventAttributes
Decodes a WorkflowTaskCompletedEventAttributes 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
WorkflowTaskCompletedEventAttributes
WorkflowTaskCompletedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowTaskCompletedEventAttributes
Decodes a WorkflowTaskCompletedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowTaskCompletedEventAttributes
WorkflowTaskCompletedEventAttributes
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 WorkflowTaskCompletedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowTaskCompletedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowTaskCompletedEventAttributes | WorkflowTaskCompletedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowTaskCompletedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowTaskCompletedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowTaskCompletedEventAttributes | WorkflowTaskCompletedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowTaskCompletedEventAttributes
Creates a WorkflowTaskCompletedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowTaskCompletedEventAttributes
WorkflowTaskCompletedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowTaskCompletedEventAttributes
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 a WorkflowTaskCompletedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowTaskCompletedEventAttributes | WorkflowTaskCompletedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object