Class: UpdateActivityOptionsRequest
workflowservice.v1.UpdateActivityOptionsRequest
NOTE: keep in sync with temporal.api.batch.v1.BatchOperationUpdateActivityOptions
Deprecated. Use UpdateActivityExecutionOptionsRequest.
Properties
activity
• Optional activity: "id" | "type" | "matchAll"
either activity id, activity type or update_all must be provided
activityOptions
• Optional activityOptions: null | $Properties
Activity options. Partial updates are accepted and controlled by update_mask
execution
• Optional execution: null | $Properties
Execution info of the workflow which scheduled this activity
id
• Optional id: null | string
Only activity with this ID will be updated.
identity
• identity: string
The identity of the client who initiated this request
matchAll
• Optional matchAll: null | boolean
Update all running activities.
namespace
• namespace: string
Namespace of the workflow which scheduled this activity
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.
type
• Optional type: null | string
Update all running activities of this type.
updateMask
• Optional updateMask: null | $Properties
Controls which fields from activity_options will be applied
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateActivityOptionsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateActivityOptionsRequest & $Shape
Creates a new UpdateActivityOptionsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
UpdateActivityOptionsRequest & $Shape
UpdateActivityOptionsRequest instance
▸ create(properties?): UpdateActivityOptionsRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): UpdateActivityOptionsRequest & $Shape
Decodes an UpdateActivityOptionsRequest 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
UpdateActivityOptionsRequest & $Shape
UpdateActivityOptionsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateActivityOptionsRequest & $Shape
Decodes an UpdateActivityOptionsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateActivityOptionsRequest & $Shape
UpdateActivityOptionsRequest
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 UpdateActivityOptionsRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityOptionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateActivityOptionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateActivityOptionsRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityOptionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateActivityOptionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateActivityOptionsRequest
Creates an UpdateActivityOptionsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateActivityOptionsRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateActivityOptionsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateActivityOptionsRequest | UpdateActivityOptionsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object