Class: BatchOperationUpdateActivityOptions
batch.v1.BatchOperationUpdateActivityOptions
BatchOperationUpdateActivityOptions sends an update-activity-options requests in a batch. NOTE: keep in sync with temporal.api.workflowservice.v1.UpdateActivityRequest
Implements
Constructors
constructor
• new BatchOperationUpdateActivityOptions(properties?): BatchOperationUpdateActivityOptions
Constructs a new BatchOperationUpdateActivityOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationUpdateActivityOptions | Properties to set |
Returns
BatchOperationUpdateActivityOptions
Properties
activity
• Optional activity: "type" | "matchAll"
The activity to update. If match_all is set to true, all activities will be updated.
activityOptions
• Optional activityOptions: null | IActivityOptions
Update Activity options. Partial updates are accepted and controlled by update_mask.
Implementation of
IBatchOperationUpdateActivityOptions.activityOptions
identity
• identity: string
The identity of the worker/client.
Implementation of
IBatchOperationUpdateActivityOptions.identity
matchAll
• Optional matchAll: null | boolean
BatchOperationUpdateActivityOptions matchAll.
Implementation of
IBatchOperationUpdateActivityOptions.matchAll
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 ActivityTaskScheduled 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
IBatchOperationUpdateActivityOptions.restoreOriginal
type
• Optional type: null | string
BatchOperationUpdateActivityOptions type.
Implementation of
IBatchOperationUpdateActivityOptions.type
updateMask
• Optional updateMask: null | IFieldMask
Controls which fields from activity_options will be applied
Implementation of
IBatchOperationUpdateActivityOptions.updateMask
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationUpdateActivityOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationUpdateActivityOptions
Creates a new BatchOperationUpdateActivityOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationUpdateActivityOptions | Properties to set |
Returns
BatchOperationUpdateActivityOptions
BatchOperationUpdateActivityOptions instance
decode
▸ decode(reader, length?): BatchOperationUpdateActivityOptions
Decodes a BatchOperationUpdateActivityOptions 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
BatchOperationUpdateActivityOptions
BatchOperationUpdateActivityOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationUpdateActivityOptions
Decodes a BatchOperationUpdateActivityOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationUpdateActivityOptions
BatchOperationUpdateActivityOptions
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 BatchOperationUpdateActivityOptions message. Does not implicitly temporal.api.batch.v1.BatchOperationUpdateActivityOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationUpdateActivityOptions | BatchOperationUpdateActivityOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationUpdateActivityOptions message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationUpdateActivityOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationUpdateActivityOptions | BatchOperationUpdateActivityOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationUpdateActivityOptions
Creates a BatchOperationUpdateActivityOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationUpdateActivityOptions
BatchOperationUpdateActivityOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationUpdateActivityOptions
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 a BatchOperationUpdateActivityOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationUpdateActivityOptions | BatchOperationUpdateActivityOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object