Class: UpdateActivityExecutionOptionsRequest

Represents an UpdateActivityExecutionOptionsRequest.

Properties

activityId

activityId: string

The ID of the activity to target.

---

activityOptions?

optional activityOptions?: $Properties | null

Activity options. Partial updates are accepted and controlled by update_mask

---

identity

identity: string

The identity of the client who initiated this request

---

namespace

namespace: string

Namespace of the workflow which scheduled this activity

---

requestId

requestId: string

Used to de-dupe update requests.

---

resourceId

resourceId: string

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

---

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.

---

runId

runId: string

Run ID of the workflow or standalone activity. If empty, targets the latest run.

---

updateMask?

optional updateMask?: $Properties | null

Controls which fields from activity_options will be applied

---

workflowId

workflowId: string

If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.

Methods

toJSON()

toJSON(): object

Converts this UpdateActivityExecutionOptionsRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): UpdateActivityExecutionOptionsRequest & $Properties

Creates a new UpdateActivityExecutionOptionsRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UpdateActivityExecutionOptionsRequest & $Properties

UpdateActivityExecutionOptionsRequest instance

Call Signature

static create(properties?): UpdateActivityExecutionOptionsRequest

Creates a new UpdateActivityExecutionOptionsRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UpdateActivityExecutionOptionsRequest

UpdateActivityExecutionOptionsRequest instance

---

decode()

static decode(reader, length?): UpdateActivityExecutionOptionsRequest & $Properties

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

UpdateActivityExecutionOptionsRequest & $Properties

UpdateActivityExecutionOptionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): UpdateActivityExecutionOptionsRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

UpdateActivityExecutionOptionsRequest & $Properties

UpdateActivityExecutionOptionsRequest

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 UpdateActivityExecutionOptionsRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityExecutionOptionsRequest.verify|verify messages.

Parameters

message

$Properties

UpdateActivityExecutionOptionsRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

UpdateActivityExecutionOptionsRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): UpdateActivityExecutionOptionsRequest

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

Parameters

object

Plain object

Returns

UpdateActivityExecutionOptionsRequest

UpdateActivityExecutionOptionsRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

UpdateActivityExecutionOptionsRequest

UpdateActivityExecutionOptionsRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object