Class: StartChildWorkflowExecutionInitiatedEventAttributes
history.v1.StartChildWorkflowExecutionInitiatedEventAttributes
Represents a StartChildWorkflowExecutionInitiatedEventAttributes.
Implements
Constructors
constructor
• new StartChildWorkflowExecutionInitiatedEventAttributes(properties?
): StartChildWorkflowExecutionInitiatedEventAttributes
Constructs a new StartChildWorkflowExecutionInitiatedEventAttributes.
Parameters
Name | Type | Description |
---|---|---|
properties? | IStartChildWorkflowExecutionInitiatedEventAttributes | Properties to set |
Returns
StartChildWorkflowExecutionInitiatedEventAttributes
Properties
control
• control: string
Deprecated
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.control
cronSchedule
• cronSchedule: string
If this child runs on a cron schedule, it will appear here
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.cronSchedule
header
• Optional
header: null
| IHeader
StartChildWorkflowExecutionInitiatedEventAttributes header.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.header
inheritBuildId
• inheritBuildId: boolean
If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment rules of the child's Task Queue will be used to independently assign a Build ID to it.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.inheritBuildId
input
• Optional
input: null
| IPayloads
StartChildWorkflowExecutionInitiatedEventAttributes input.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.input
memo
• Optional
memo: null
| IMemo
StartChildWorkflowExecutionInitiatedEventAttributes memo.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.memo
namespace
• namespace: string
Namespace of the child workflow.
SDKs and UI tools should use namespace
field but server must use namespace_id
only.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.namespace
namespaceId
• namespaceId: string
StartChildWorkflowExecutionInitiatedEventAttributes namespaceId.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.namespaceId
parentClosePolicy
• parentClosePolicy: ParentClosePolicy
Default: PARENT_CLOSE_POLICY_TERMINATE.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.parentClosePolicy
retryPolicy
• Optional
retryPolicy: null
| IRetryPolicy
StartChildWorkflowExecutionInitiatedEventAttributes retryPolicy.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.retryPolicy
searchAttributes
• Optional
searchAttributes: null
| ISearchAttributes
StartChildWorkflowExecutionInitiatedEventAttributes searchAttributes.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.searchAttributes
taskQueue
• Optional
taskQueue: null
| ITaskQueue
StartChildWorkflowExecutionInitiatedEventAttributes taskQueue.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.taskQueue
workflowExecutionTimeout
• Optional
workflowExecutionTimeout: null
| IDuration
Total workflow execution timeout including retries and continue as new.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowExecutionTimeout
workflowId
• workflowId: string
StartChildWorkflowExecutionInitiatedEventAttributes workflowId.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowId
workflowIdReusePolicy
• workflowIdReusePolicy: WorkflowIdReusePolicy
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowIdReusePolicy
workflowRunTimeout
• Optional
workflowRunTimeout: null
| IDuration
Timeout of a single workflow run.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowRunTimeout
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED
event which this command was reported with
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowTaskCompletedEventId
workflowTaskTimeout
• Optional
workflowTaskTimeout: null
| IDuration
Timeout of a single workflow task.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowTaskTimeout
workflowType
• Optional
workflowType: null
| IWorkflowType
StartChildWorkflowExecutionInitiatedEventAttributes workflowType.
Implementation of
IStartChildWorkflowExecutionInitiatedEventAttributes.workflowType
Methods
toJSON
▸ toJSON(): Object
Converts this StartChildWorkflowExecutionInitiatedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): StartChildWorkflowExecutionInitiatedEventAttributes
Creates a new StartChildWorkflowExecutionInitiatedEventAttributes instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IStartChildWorkflowExecutionInitiatedEventAttributes | Properties to set |
Returns
StartChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiatedEventAttributes instance
decode
▸ decode(reader
, length?
): StartChildWorkflowExecutionInitiatedEventAttributes
Decodes a StartChildWorkflowExecutionInitiatedEventAttributes 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
StartChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiatedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): StartChildWorkflowExecutionInitiatedEventAttributes
Decodes a StartChildWorkflowExecutionInitiatedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiatedEventAttributes
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 StartChildWorkflowExecutionInitiatedEventAttributes message. Does not implicitly temporal.api.history.v1.StartChildWorkflowExecutionInitiatedEventAttributes.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IStartChildWorkflowExecutionInitiatedEventAttributes | StartChildWorkflowExecutionInitiatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified StartChildWorkflowExecutionInitiatedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.StartChildWorkflowExecutionInitiatedEventAttributes.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IStartChildWorkflowExecutionInitiatedEventAttributes | StartChildWorkflowExecutionInitiatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): StartChildWorkflowExecutionInitiatedEventAttributes
Creates a StartChildWorkflowExecutionInitiatedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
StartChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiatedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for StartChildWorkflowExecutionInitiatedEventAttributes
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 StartChildWorkflowExecutionInitiatedEventAttributes message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | StartChildWorkflowExecutionInitiatedEventAttributes | StartChildWorkflowExecutionInitiatedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object