Class: WorkflowExecutionOptions
workflow.v1.WorkflowExecutionOptions
Represents a WorkflowExecutionOptions.
Implements
Constructors
constructor
• new WorkflowExecutionOptions(properties?): WorkflowExecutionOptions
Constructs a new WorkflowExecutionOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionOptions | Properties to set |
Returns
Properties
versioningOverride
• Optional versioningOverride: null | IVersioningOverride
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
Implementation of
IWorkflowExecutionOptions.versioningOverride
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionOptions
Creates a new WorkflowExecutionOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionOptions | Properties to set |
Returns
WorkflowExecutionOptions instance
decode
▸ decode(reader, length?): WorkflowExecutionOptions
Decodes a WorkflowExecutionOptions 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
WorkflowExecutionOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionOptions
Decodes a WorkflowExecutionOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionOptions
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 WorkflowExecutionOptions message. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionOptions | WorkflowExecutionOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionOptions message, length delimited. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionOptions | WorkflowExecutionOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionOptions
Creates a WorkflowExecutionOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowExecutionOptions
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 WorkflowExecutionOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionOptions | WorkflowExecutionOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object