Class: UpdateWorkflowExecutionOptionsRequest
workflowservice.v1.UpdateWorkflowExecutionOptionsRequest
Keep the parameters in sync with:
- temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.
- temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.
Properties
identity
• identity: string
Optional. The identity of the client who initiated this request.
namespace
• namespace: string
The namespace name of the target Workflow.
updateMask
• Optional updateMask: null | $Properties
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.
workflowExecution
• Optional workflowExecution: null | $Properties
The target Workflow Id and (optionally) a specific Run Id thereof. (-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: false positive triggered by the word "optional" --)
workflowExecutionOptions
• Optional workflowExecutionOptions: null | $Properties
Workflow Execution options. Partial updates are accepted and controlled by update_mask.
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkflowExecutionOptionsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkflowExecutionOptionsRequest & $Shape
Creates a new UpdateWorkflowExecutionOptionsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
UpdateWorkflowExecutionOptionsRequest & $Shape
UpdateWorkflowExecutionOptionsRequest instance
▸ create(properties?): UpdateWorkflowExecutionOptionsRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
UpdateWorkflowExecutionOptionsRequest
decode
▸ decode(reader, length?): UpdateWorkflowExecutionOptionsRequest & $Shape
Decodes an UpdateWorkflowExecutionOptionsRequest 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
UpdateWorkflowExecutionOptionsRequest & $Shape
UpdateWorkflowExecutionOptionsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkflowExecutionOptionsRequest & $Shape
Decodes an UpdateWorkflowExecutionOptionsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkflowExecutionOptionsRequest & $Shape
UpdateWorkflowExecutionOptionsRequest
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 UpdateWorkflowExecutionOptionsRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkflowExecutionOptionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkflowExecutionOptionsRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkflowExecutionOptionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkflowExecutionOptionsRequest
Creates an UpdateWorkflowExecutionOptionsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkflowExecutionOptionsRequest
UpdateWorkflowExecutionOptionsRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateWorkflowExecutionOptionsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkflowExecutionOptionsRequest | UpdateWorkflowExecutionOptionsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object