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

Activity options. Partial updates are accepted and controlled by update_mask

---

execution?

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

---

id?

optional id?: string | null

Only activity with this ID will be updated.

---

identity

identity: string

The identity of the client who initiated this request

---

matchAll?

optional matchAll?: boolean | null

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?: string | null

Update all running activities of this type.

---

updateMask?

optional updateMask?: $Properties | null

Controls which fields from activity_options will be applied

Methods

toJSON()

toJSON(): object

Converts this UpdateActivityOptionsRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): UpdateActivityOptionsRequest & $Shape

Creates a new UpdateActivityOptionsRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

UpdateActivityOptionsRequest & $Shape

UpdateActivityOptionsRequest instance

Call Signature

static create(properties?): UpdateActivityOptionsRequest

Creates a new UpdateActivityOptionsRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UpdateActivityOptionsRequest

UpdateActivityOptionsRequest instance

---

decode()

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

Decodes an UpdateActivityOptionsRequest 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

UpdateActivityOptionsRequest & $Shape

UpdateActivityOptionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): UpdateActivityOptionsRequest & $Shape

Decodes an UpdateActivityOptionsRequest message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static encode(message, writer?): Writer

Encodes the specified UpdateActivityOptionsRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityOptionsRequest.verify|verify messages.

Parameters

message

$Properties

UpdateActivityOptionsRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

UpdateActivityOptionsRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): UpdateActivityOptionsRequest

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

Parameters

object

Plain object

Returns

UpdateActivityOptionsRequest

UpdateActivityOptionsRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

UpdateActivityOptionsRequest

UpdateActivityOptionsRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object