Class: UpdateScheduleRequest

workflowservice.v1.UpdateScheduleRequest

Represents an UpdateScheduleRequest.

Implements

• IUpdateScheduleRequest

Constructors

constructor

• new UpdateScheduleRequest(properties?): UpdateScheduleRequest

Constructs a new UpdateScheduleRequest.

Parameters

Name	Type	Description
properties?	IUpdateScheduleRequest	Properties to set

Returns

UpdateScheduleRequest

Properties

conflictToken

• conflictToken: Uint8Array

This can be the value of conflict_token from a DescribeScheduleResponse, which will cause this request to fail if the schedule has been modified between the Describe and this Update. If missing, the schedule will be updated unconditionally.

Implementation of

IUpdateScheduleRequest.conflictToken

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IUpdateScheduleRequest.identity

---

namespace

• namespace: string

The namespace of the schedule to update.

Implementation of

IUpdateScheduleRequest.namespace

---

requestId

• requestId: string

A unique identifier for this update request for idempotence. Typically UUIDv4.

Implementation of

IUpdateScheduleRequest.requestId

---

schedule

• Optional schedule: null | ISchedule

The new schedule. The four main fields of the schedule (spec, action, policies, state) are replaced completely by the values in this message.

Implementation of

IUpdateScheduleRequest.schedule

---

scheduleId

• scheduleId: string

The id of the schedule to update.

Implementation of

IUpdateScheduleRequest.scheduleId

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

Schedule search attributes to be updated. Do not set this field if you do not want to update the search attributes. A non-null empty object will set the search attributes to an empty map. Note: you cannot only update the search attributes with UpdateScheduleRequest, you must also set the schedule field; otherwise, it will unset the schedule.

Implementation of

IUpdateScheduleRequest.searchAttributes

Methods

toJSON

▸ toJSON(): Object

Converts this UpdateScheduleRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): UpdateScheduleRequest

Creates a new UpdateScheduleRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IUpdateScheduleRequest	Properties to set

Returns

UpdateScheduleRequest

UpdateScheduleRequest instance

---

decode

▸ decode(reader, length?): UpdateScheduleRequest

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

UpdateScheduleRequest

UpdateScheduleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): UpdateScheduleRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

UpdateScheduleRequest

UpdateScheduleRequest

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

Parameters

Name	Type	Description
message	IUpdateScheduleRequest	UpdateScheduleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IUpdateScheduleRequest	UpdateScheduleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): UpdateScheduleRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

UpdateScheduleRequest

UpdateScheduleRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UpdateScheduleRequest

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 UpdateScheduleRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	UpdateScheduleRequest	UpdateScheduleRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object