Class: ChildWorkflowExecutionCanceledEventAttributes
history.v1.ChildWorkflowExecutionCanceledEventAttributes
Represents a ChildWorkflowExecutionCanceledEventAttributes.
Properties
details
• Optional details: null | $Properties
ChildWorkflowExecutionCanceledEventAttributes details.
initiatedEventId
• initiatedEventId: Long
Id of the START_CHILD_WORKFLOW_EXECUTION_INITIATED event which this event corresponds to
namespace
• namespace: string
Namespace of the child workflow.
SDKs and UI tools should use namespace field but server must use namespace_id only.
namespaceId
• namespaceId: string
ChildWorkflowExecutionCanceledEventAttributes namespaceId.
startedEventId
• startedEventId: Long
Id of the CHILD_WORKFLOW_EXECUTION_STARTED event which this event corresponds to
workflowExecution
• Optional workflowExecution: null | $Properties
ChildWorkflowExecutionCanceledEventAttributes workflowExecution.
workflowType
• Optional workflowType: null | $Properties
ChildWorkflowExecutionCanceledEventAttributes workflowType.
Methods
toJSON
▸ toJSON(): Object
Converts this ChildWorkflowExecutionCanceledEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ChildWorkflowExecutionCanceledEventAttributes & $Properties
Creates a new ChildWorkflowExecutionCanceledEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ChildWorkflowExecutionCanceledEventAttributes & $Properties
ChildWorkflowExecutionCanceledEventAttributes instance
▸ create(properties?): ChildWorkflowExecutionCanceledEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
ChildWorkflowExecutionCanceledEventAttributes
decode
▸ decode(reader, length?): ChildWorkflowExecutionCanceledEventAttributes & $Properties
Decodes a ChildWorkflowExecutionCanceledEventAttributes 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
ChildWorkflowExecutionCanceledEventAttributes & $Properties
ChildWorkflowExecutionCanceledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ChildWorkflowExecutionCanceledEventAttributes & $Properties
Decodes a ChildWorkflowExecutionCanceledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ChildWorkflowExecutionCanceledEventAttributes & $Properties
ChildWorkflowExecutionCanceledEventAttributes
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 ChildWorkflowExecutionCanceledEventAttributes message. Does not implicitly temporal.api.history.v1.ChildWorkflowExecutionCanceledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ChildWorkflowExecutionCanceledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ChildWorkflowExecutionCanceledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.ChildWorkflowExecutionCanceledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ChildWorkflowExecutionCanceledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ChildWorkflowExecutionCanceledEventAttributes
Creates a ChildWorkflowExecutionCanceledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ChildWorkflowExecutionCanceledEventAttributes
ChildWorkflowExecutionCanceledEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ChildWorkflowExecutionCanceledEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ChildWorkflowExecutionCanceledEventAttributes | ChildWorkflowExecutionCanceledEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object