Skip to main content

Class: BatchOperationUpdateActivityOptions

BatchOperationUpdateActivityOptions sends an update-activity-options requests in a batch. NOTE: keep in sync with temporal.api.workflowservice.v1.UpdateActivityRequest

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?: $Properties | null

Update Activity options. Partial updates are accepted and controlled by update_mask.

identity​

identity: string

The identity of the worker/client.

matchAll?​

optional matchAll?: boolean | null

BatchOperationUpdateActivityOptions 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.

type?​

optional type?: string | null

BatchOperationUpdateActivityOptions type.

updateMask?​

optional updateMask?: $Properties | null

Controls which fields from activity_options will be applied

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationUpdateActivityOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationUpdateActivityOptions & $Shape

Creates a new BatchOperationUpdateActivityOptions instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

BatchOperationUpdateActivityOptions & $Shape

BatchOperationUpdateActivityOptions instance

Call Signature​

static create(properties?): BatchOperationUpdateActivityOptions

Creates a new BatchOperationUpdateActivityOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationUpdateActivityOptions

BatchOperationUpdateActivityOptions instance

decode()​

static decode(reader, length?): BatchOperationUpdateActivityOptions & $Shape

Decodes a BatchOperationUpdateActivityOptions message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

BatchOperationUpdateActivityOptions & $Shape

BatchOperationUpdateActivityOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationUpdateActivityOptions & $Shape

Decodes a BatchOperationUpdateActivityOptions message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationUpdateActivityOptions & $Shape

BatchOperationUpdateActivityOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified BatchOperationUpdateActivityOptions message. Does not implicitly temporal.api.batch.v1.BatchOperationUpdateActivityOptions.verify|verify messages.

Parameters​

message​

$Properties

BatchOperationUpdateActivityOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified BatchOperationUpdateActivityOptions message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationUpdateActivityOptions.verify|verify messages.

Parameters​

message​

$Properties

BatchOperationUpdateActivityOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationUpdateActivityOptions

Creates a BatchOperationUpdateActivityOptions message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

BatchOperationUpdateActivityOptions

BatchOperationUpdateActivityOptions

toObject()​

static toObject(message, options?): object

Creates a plain object from a BatchOperationUpdateActivityOptions message. Also converts values to other types if specified.

Parameters​

message​

BatchOperationUpdateActivityOptions

BatchOperationUpdateActivityOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object