Class: UpdateActivityExecutionOptionsRequest
workflowservice.v1.UpdateActivityExecutionOptionsRequest
Represents an UpdateActivityExecutionOptionsRequest.
Implements
Constructors
constructor
• new UpdateActivityExecutionOptionsRequest(properties?): UpdateActivityExecutionOptionsRequest
Constructs a new UpdateActivityExecutionOptionsRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateActivityExecutionOptionsRequest | Properties to set |
Returns
UpdateActivityExecutionOptionsRequest
Properties
activityId
• activityId: string
The ID of the activity to target.
Implementation of
IUpdateActivityExecutionOptionsRequest.activityId
activityOptions
• Optional activityOptions: null | IActivityOptions
Activity options. Partial updates are accepted and controlled by update_mask
Implementation of
IUpdateActivityExecutionOptionsRequest.activityOptions
identity
• identity: string
The identity of the client who initiated this request
Implementation of
IUpdateActivityExecutionOptionsRequest.identity
namespace
• namespace: string
Namespace of the workflow which scheduled this activity
Implementation of
IUpdateActivityExecutionOptionsRequest.namespace
resourceId
• resourceId: string
Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
Implementation of
IUpdateActivityExecutionOptionsRequest.resourceId
restoreOriginal
• restoreOriginal: boolean
If set, the activity options will be restored to the default. Default options are then options activity was created with. They are part of the first schedule event. This flag cannot be combined with any other option; if you supply restore_original together with other options, the request will be rejected.
Implementation of
IUpdateActivityExecutionOptionsRequest.restoreOriginal
runId
• runId: string
Run ID of the workflow or standalone activity.
Implementation of
IUpdateActivityExecutionOptionsRequest.runId
updateMask
• Optional updateMask: null | IFieldMask
Controls which fields from activity_options will be applied
Implementation of
IUpdateActivityExecutionOptionsRequest.updateMask
workflowId
• workflowId: string
If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.
Implementation of
IUpdateActivityExecutionOptionsRequest.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateActivityExecutionOptionsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateActivityExecutionOptionsRequest
Creates a new UpdateActivityExecutionOptionsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateActivityExecutionOptionsRequest | Properties to set |
Returns
UpdateActivityExecutionOptionsRequest
UpdateActivityExecutionOptionsRequest instance
decode
▸ decode(reader, length?): UpdateActivityExecutionOptionsRequest
Decodes an UpdateActivityExecutionOptionsRequest 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
UpdateActivityExecutionOptionsRequest
UpdateActivityExecutionOptionsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateActivityExecutionOptionsRequest
Decodes an UpdateActivityExecutionOptionsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateActivityExecutionOptionsRequest
UpdateActivityExecutionOptionsRequest
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 UpdateActivityExecutionOptionsRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityExecutionOptionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateActivityExecutionOptionsRequest | UpdateActivityExecutionOptionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateActivityExecutionOptionsRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityExecutionOptionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateActivityExecutionOptionsRequest | UpdateActivityExecutionOptionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateActivityExecutionOptionsRequest
Creates an UpdateActivityExecutionOptionsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateActivityExecutionOptionsRequest
UpdateActivityExecutionOptionsRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateActivityExecutionOptionsRequest
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 UpdateActivityExecutionOptionsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateActivityExecutionOptionsRequest | UpdateActivityExecutionOptionsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object