Class: StartChildWorkflowExecutionCommandAttributes
command.v1.StartChildWorkflowExecutionCommandAttributes
Represents a StartChildWorkflowExecutionCommandAttributes.
Implements
Constructors
constructor
• new StartChildWorkflowExecutionCommandAttributes(properties?): StartChildWorkflowExecutionCommandAttributes
Constructs a new StartChildWorkflowExecutionCommandAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartChildWorkflowExecutionCommandAttributes | Properties to set |
Returns
StartChildWorkflowExecutionCommandAttributes
Properties
control
• control: string
StartChildWorkflowExecutionCommandAttributes control.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.control
cronSchedule
• cronSchedule: string
Establish a cron schedule for the child workflow.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.cronSchedule
header
• Optional header: null | IHeader
StartChildWorkflowExecutionCommandAttributes header.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.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
IStartChildWorkflowExecutionCommandAttributes.inheritBuildId
input
• Optional input: null | IPayloads
StartChildWorkflowExecutionCommandAttributes input.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.input
memo
• Optional memo: null | IMemo
StartChildWorkflowExecutionCommandAttributes memo.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.memo
namespace
• namespace: string
StartChildWorkflowExecutionCommandAttributes namespace.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.namespace
parentClosePolicy
• parentClosePolicy: ParentClosePolicy
Default: PARENT_CLOSE_POLICY_TERMINATE.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.parentClosePolicy
retryPolicy
• Optional retryPolicy: null | IRetryPolicy
StartChildWorkflowExecutionCommandAttributes retryPolicy.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.retryPolicy
searchAttributes
• Optional searchAttributes: null | ISearchAttributes
StartChildWorkflowExecutionCommandAttributes searchAttributes.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.searchAttributes
taskQueue
• Optional taskQueue: null | ITaskQueue
StartChildWorkflowExecutionCommandAttributes taskQueue.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.taskQueue
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | IDuration
Total workflow execution timeout including retries and continue as new.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.workflowExecutionTimeout
workflowId
• workflowId: string
StartChildWorkflowExecutionCommandAttributes workflowId.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.workflowId
workflowIdReusePolicy
• workflowIdReusePolicy: WorkflowIdReusePolicy
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.workflowIdReusePolicy
workflowRunTimeout
• Optional workflowRunTimeout: null | IDuration
Timeout of a single workflow run.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.workflowRunTimeout
workflowTaskTimeout
• Optional workflowTaskTimeout: null | IDuration
Timeout of a single workflow task.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.workflowTaskTimeout
workflowType
• Optional workflowType: null | IWorkflowType
StartChildWorkflowExecutionCommandAttributes workflowType.
Implementation of
IStartChildWorkflowExecutionCommandAttributes.workflowType
Methods
toJSON
▸ toJSON(): Object
Converts this StartChildWorkflowExecutionCommandAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartChildWorkflowExecutionCommandAttributes
Creates a new StartChildWorkflowExecutionCommandAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartChildWorkflowExecutionCommandAttributes | Properties to set |
Returns
StartChildWorkflowExecutionCommandAttributes
StartChildWorkflowExecutionCommandAttributes instance
decode
▸ decode(reader, length?): StartChildWorkflowExecutionCommandAttributes
Decodes a StartChildWorkflowExecutionCommandAttributes 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
StartChildWorkflowExecutionCommandAttributes
StartChildWorkflowExecutionCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartChildWorkflowExecutionCommandAttributes
Decodes a StartChildWorkflowExecutionCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartChildWorkflowExecutionCommandAttributes
StartChildWorkflowExecutionCommandAttributes
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 StartChildWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartChildWorkflowExecutionCommandAttributes | StartChildWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartChildWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartChildWorkflowExecutionCommandAttributes | StartChildWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartChildWorkflowExecutionCommandAttributes
Creates a StartChildWorkflowExecutionCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartChildWorkflowExecutionCommandAttributes
StartChildWorkflowExecutionCommandAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for StartChildWorkflowExecutionCommandAttributes
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 StartChildWorkflowExecutionCommandAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartChildWorkflowExecutionCommandAttributes | StartChildWorkflowExecutionCommandAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object