Class: ChildWorkflowExecutionStartedEventAttributes
history.v1.ChildWorkflowExecutionStartedEventAttributes
Represents a ChildWorkflowExecutionStartedEventAttributes.
Properties
header
• Optional header: null | $Properties
ChildWorkflowExecutionStartedEventAttributes header.
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
ChildWorkflowExecutionStartedEventAttributes namespaceId.
workflowExecution
• Optional workflowExecution: null | $Properties
ChildWorkflowExecutionStartedEventAttributes workflowExecution.
workflowType
• Optional workflowType: null | $Properties
ChildWorkflowExecutionStartedEventAttributes workflowType.
Methods
toJSON
▸ toJSON(): Object
Converts this ChildWorkflowExecutionStartedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ChildWorkflowExecutionStartedEventAttributes & $Properties
Creates a new ChildWorkflowExecutionStartedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ChildWorkflowExecutionStartedEventAttributes & $Properties
ChildWorkflowExecutionStartedEventAttributes instance
▸ create(properties?): ChildWorkflowExecutionStartedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
ChildWorkflowExecutionStartedEventAttributes
decode
▸ decode(reader, length?): ChildWorkflowExecutionStartedEventAttributes & $Properties
Decodes a ChildWorkflowExecutionStartedEventAttributes 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
ChildWorkflowExecutionStartedEventAttributes & $Properties
ChildWorkflowExecutionStartedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ChildWorkflowExecutionStartedEventAttributes & $Properties
Decodes a ChildWorkflowExecutionStartedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ChildWorkflowExecutionStartedEventAttributes & $Properties
ChildWorkflowExecutionStartedEventAttributes
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 ChildWorkflowExecutionStartedEventAttributes message. Does not implicitly temporal.api.history.v1.ChildWorkflowExecutionStartedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ChildWorkflowExecutionStartedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ChildWorkflowExecutionStartedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.ChildWorkflowExecutionStartedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ChildWorkflowExecutionStartedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ChildWorkflowExecutionStartedEventAttributes
Creates a ChildWorkflowExecutionStartedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ChildWorkflowExecutionStartedEventAttributes
ChildWorkflowExecutionStartedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ChildWorkflowExecutionStartedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ChildWorkflowExecutionStartedEventAttributes | ChildWorkflowExecutionStartedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object