Class: WorkflowExecutionConfig
workflow.v1.WorkflowExecutionConfig
Represents a WorkflowExecutionConfig.
Implements
Constructors
constructor
• new WorkflowExecutionConfig(properties?): WorkflowExecutionConfig
Constructs a new WorkflowExecutionConfig.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionConfig | Properties to set |
Returns
Properties
defaultWorkflowTaskTimeout
• Optional defaultWorkflowTaskTimeout: null | IDuration
WorkflowExecutionConfig defaultWorkflowTaskTimeout.
Implementation of
IWorkflowExecutionConfig.defaultWorkflowTaskTimeout
taskQueue
• Optional taskQueue: null | ITaskQueue
WorkflowExecutionConfig taskQueue.
Implementation of
IWorkflowExecutionConfig.taskQueue
userMetadata
• Optional userMetadata: null | IUserMetadata
User metadata provided on start workflow.
Implementation of
IWorkflowExecutionConfig.userMetadata
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | IDuration
WorkflowExecutionConfig workflowExecutionTimeout.
Implementation of
IWorkflowExecutionConfig.workflowExecutionTimeout
workflowRunTimeout
• Optional workflowRunTimeout: null | IDuration
WorkflowExecutionConfig workflowRunTimeout.
Implementation of
IWorkflowExecutionConfig.workflowRunTimeout
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionConfig to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionConfig
Creates a new WorkflowExecutionConfig instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionConfig | Properties to set |
Returns
WorkflowExecutionConfig instance
decode
▸ decode(reader, length?): WorkflowExecutionConfig
Decodes a WorkflowExecutionConfig 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
WorkflowExecutionConfig
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionConfig
Decodes a WorkflowExecutionConfig message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionConfig
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 WorkflowExecutionConfig message. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionConfig | WorkflowExecutionConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionConfig message, length delimited. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionConfig | WorkflowExecutionConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionConfig
Creates a WorkflowExecutionConfig message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionConfig
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowExecutionConfig
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 WorkflowExecutionConfig message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionConfig | WorkflowExecutionConfig |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object