Class: UpdateWorkflowOptions
v1.PostResetOperation.UpdateWorkflowOptions
UpdateWorkflowOptions represents updating workflow execution options after a workflow reset. Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.
Implements
Constructors
constructor
• new UpdateWorkflowOptions(properties?): UpdateWorkflowOptions
Constructs a new UpdateWorkflowOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowOptions | Properties to set |
Returns
Properties
updateMask
• Optional updateMask: null | IFieldMask
Controls which fields from workflow_execution_options will be applied.
To unset a field, set it to null and use the update mask to indicate that it should be mutated.
Implementation of
IUpdateWorkflowOptions.updateMask
workflowExecutionOptions
• Optional workflowExecutionOptions: null | IWorkflowExecutionOptions
Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask.
Implementation of
IUpdateWorkflowOptions.workflowExecutionOptions
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkflowOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkflowOptions
Creates a new UpdateWorkflowOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowOptions | Properties to set |
Returns
UpdateWorkflowOptions instance
decode
▸ decode(reader, length?): UpdateWorkflowOptions
Decodes an UpdateWorkflowOptions 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
UpdateWorkflowOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkflowOptions
Decodes an UpdateWorkflowOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkflowOptions
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 UpdateWorkflowOptions message. Does not implicitly temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowOptions | UpdateWorkflowOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkflowOptions message, length delimited. Does not implicitly temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowOptions | UpdateWorkflowOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkflowOptions
Creates an UpdateWorkflowOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkflowOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateWorkflowOptions
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 an UpdateWorkflowOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkflowOptions | UpdateWorkflowOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object