Class: ChildWorkflowResult
coresdk.child_workflow.ChildWorkflowResult
Used by core to resolve child workflow executions.
Implements
Constructors
constructor
• new ChildWorkflowResult(properties?): ChildWorkflowResult
Constructs a new ChildWorkflowResult.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IChildWorkflowResult | Properties to set |
Returns
Properties
cancelled
• Optional cancelled: null | ICancellation
ChildWorkflowResult cancelled.
Implementation of
IChildWorkflowResult.cancelled
completed
• Optional completed: null | ISuccess
ChildWorkflowResult completed.
Implementation of
IChildWorkflowResult.completed
failed
• Optional failed: null | IFailure
ChildWorkflowResult failed.
Implementation of
status
• Optional status: "completed" | "failed" | "cancelled"
ChildWorkflowResult status.
Methods
toJSON
▸ toJSON(): Object
Converts this ChildWorkflowResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ChildWorkflowResult
Creates a new ChildWorkflowResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IChildWorkflowResult | Properties to set |
Returns
ChildWorkflowResult instance
decode
▸ decode(reader, length?): ChildWorkflowResult
Decodes a ChildWorkflowResult 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
ChildWorkflowResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ChildWorkflowResult
Decodes a ChildWorkflowResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ChildWorkflowResult
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 ChildWorkflowResult message. Does not implicitly coresdk.child_workflow.ChildWorkflowResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IChildWorkflowResult | ChildWorkflowResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ChildWorkflowResult message, length delimited. Does not implicitly coresdk.child_workflow.ChildWorkflowResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IChildWorkflowResult | ChildWorkflowResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ChildWorkflowResult
Creates a ChildWorkflowResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ChildWorkflowResult
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ChildWorkflowResult
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 ChildWorkflowResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ChildWorkflowResult | ChildWorkflowResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object