Class: UpdateWorkflowExecutionRequest
workflowservice.v1.UpdateWorkflowExecutionRequest
(-- api-linter: core::0134=disabled aip.dev/not-precedent: Update RPCs don't follow Google API format. --)
Implements
Constructors
constructor
• new UpdateWorkflowExecutionRequest(properties?): UpdateWorkflowExecutionRequest
Constructs a new UpdateWorkflowExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowExecutionRequest | Properties to set |
Returns
UpdateWorkflowExecutionRequest
Properties
firstExecutionRunId
• firstExecutionRunId: string
If set, this call will error if the most recent (if no Run Id is set on
workflow_execution), or specified (if it is) Workflow Execution is not
part of the same execution chain as this Id.
Implementation of
IUpdateWorkflowExecutionRequest.firstExecutionRunId
namespace
• namespace: string
The namespace name of the target Workflow.
Implementation of
IUpdateWorkflowExecutionRequest.namespace
request
• Optional request: null | IRequest
The request information that will be delivered all the way down to the Workflow Execution.
Implementation of
IUpdateWorkflowExecutionRequest.request
waitPolicy
• Optional waitPolicy: null | IWaitPolicy
Specifies client's intent to wait for Update results. NOTE: This field works together with API call timeout which is limited by server timeout (maximum wait time). If server timeout is expired before user specified timeout, API call returns even if specified stage is not reached. Actual reached stage will be included in the response.
Implementation of
IUpdateWorkflowExecutionRequest.waitPolicy
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
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" --)
Implementation of
IUpdateWorkflowExecutionRequest.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkflowExecutionRequest
Creates a new UpdateWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowExecutionRequest | Properties to set |
Returns
UpdateWorkflowExecutionRequest
UpdateWorkflowExecutionRequest instance
decode
▸ decode(reader, length?): UpdateWorkflowExecutionRequest
Decodes an UpdateWorkflowExecutionRequest 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
UpdateWorkflowExecutionRequest
UpdateWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkflowExecutionRequest
Decodes an UpdateWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkflowExecutionRequest
UpdateWorkflowExecutionRequest
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 UpdateWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowExecutionRequest | UpdateWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowExecutionRequest | UpdateWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkflowExecutionRequest
Creates an UpdateWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkflowExecutionRequest
UpdateWorkflowExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateWorkflowExecutionRequest
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 UpdateWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkflowExecutionRequest | UpdateWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object