Class: WorkflowExecutionConfig
workflow.v1.WorkflowExecutionConfig
Represents a WorkflowExecutionConfig.
Properties
defaultWorkflowTaskTimeout
• Optional defaultWorkflowTaskTimeout: null | $Properties
WorkflowExecutionConfig defaultWorkflowTaskTimeout.
taskQueue
• Optional taskQueue: null | $Properties
WorkflowExecutionConfig taskQueue.
userMetadata
• Optional userMetadata: null | $Properties
User metadata provided on start workflow.
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | $Properties
WorkflowExecutionConfig workflowExecutionTimeout.
workflowRunTimeout
• Optional workflowRunTimeout: null | $Properties
WorkflowExecutionConfig workflowRunTimeout.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionConfig to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionConfig & $Properties
Creates a new WorkflowExecutionConfig instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecutionConfig & $Properties
WorkflowExecutionConfig instance
▸ create(properties?): WorkflowExecutionConfig
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowExecutionConfig & $Properties
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 & $Properties
WorkflowExecutionConfig
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionConfig & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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