Class: UpdateActivityOptionsRequest

workflowservice.v1.UpdateActivityOptionsRequest

Represents an UpdateActivityOptionsRequest.

Implements

• IUpdateActivityOptionsRequest

Constructors

constructor

• new UpdateActivityOptionsRequest(properties?): UpdateActivityOptionsRequest

Constructs a new UpdateActivityOptionsRequest.

Parameters

Name	Type	Description
properties?	IUpdateActivityOptionsRequest	Properties to set

Returns

UpdateActivityOptionsRequest

Properties

activity

• Optional activity: "id" | "type"

either activity id or activity type must be provided

---

activityOptions

• Optional activityOptions: null | IActivityOptions

Activity options. Partial updates are accepted and controlled by update_mask

Implementation of

IUpdateActivityOptionsRequest.activityOptions

---

execution

• Optional execution: null | IWorkflowExecution

Execution info of the workflow which scheduled this activity

Implementation of

IUpdateActivityOptionsRequest.execution

---

id

• Optional id: null | string

Only activity with this ID will be updated.

Implementation of

IUpdateActivityOptionsRequest.id

---

identity

• identity: string

The identity of the client who initiated this request

Implementation of

IUpdateActivityOptionsRequest.identity

---

namespace

• namespace: string

Namespace of the workflow which scheduled this activity

Implementation of

IUpdateActivityOptionsRequest.namespace

---

type

• Optional type: null | string

Update all running activities of this type.

Implementation of

IUpdateActivityOptionsRequest.type

---

updateMask

• Optional updateMask: null | IFieldMask

Controls which fields from activity_options will be applied

Implementation of

IUpdateActivityOptionsRequest.updateMask

Methods

toJSON

▸ toJSON(): Object

Converts this UpdateActivityOptionsRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): UpdateActivityOptionsRequest

Creates a new UpdateActivityOptionsRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IUpdateActivityOptionsRequest	Properties to set

Returns

UpdateActivityOptionsRequest

UpdateActivityOptionsRequest instance

---

decode

▸ decode(reader, length?): UpdateActivityOptionsRequest

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

UpdateActivityOptionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): UpdateActivityOptionsRequest

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

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	IUpdateActivityOptionsRequest	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	IUpdateActivityOptionsRequest	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

UpdateActivityOptionsRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UpdateActivityOptionsRequest

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