Class: WorkflowActivationCompletion
coresdk.workflow_completion.WorkflowActivationCompletion
Result of a single workflow activation, reported from lang to core
Properties
failed
• Optional failed: null | $Properties
WorkflowActivationCompletion failed.
payloadDownloadMetrics
• Optional payloadDownloadMetrics: null | $Properties
Metrics for external payload storage downloads (retrievals) performed while processing this activation. Only set when external storage retrieved payloads.
payloadUploadMetrics
• Optional payloadUploadMetrics: null | $Properties
Metrics for external payload storage uploads (stores) performed while processing this activation. Only set when external storage stored payloads.
runId
• runId: string
The run id from the workflow activation you are completing
status
• Optional status: "failed" | "successful"
WorkflowActivationCompletion status.
successful
• Optional successful: null | $Properties
WorkflowActivationCompletion successful.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowActivationCompletion to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowActivationCompletion & $Shape
Creates a new WorkflowActivationCompletion instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowActivationCompletion & $Shape
WorkflowActivationCompletion instance
▸ create(properties?): WorkflowActivationCompletion
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowActivationCompletion & $Shape
Decodes a WorkflowActivationCompletion 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
WorkflowActivationCompletion & $Shape
WorkflowActivationCompletion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowActivationCompletion & $Shape
Decodes a WorkflowActivationCompletion message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowActivationCompletion & $Shape
WorkflowActivationCompletion
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 WorkflowActivationCompletion message. Does not implicitly coresdk.workflow_completion.WorkflowActivationCompletion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowActivationCompletion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowActivationCompletion message, length delimited. Does not implicitly coresdk.workflow_completion.WorkflowActivationCompletion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowActivationCompletion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowActivationCompletion
Creates a WorkflowActivationCompletion message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowActivationCompletion
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowActivationCompletion message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowActivationCompletion | WorkflowActivationCompletion |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object