Class: CreateScheduleRequest

workflowservice.v1.CreateScheduleRequest

(-- api-linter: core::0133::request-parent-required=disabled aip.dev/not-precedent: CreateSchedule doesn't follow Google API format --) (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: CreateSchedule doesn't follow Google API format --) (-- api-linter: core::0133::request-resource-behavior=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --) (-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)

Implements

• ICreateScheduleRequest

Constructors

constructor

• new CreateScheduleRequest(properties?): CreateScheduleRequest

Constructs a new CreateScheduleRequest.

Parameters

Name	Type	Description
properties?	ICreateScheduleRequest	Properties to set

Returns

CreateScheduleRequest

Properties

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

ICreateScheduleRequest.identity

---

initialPatch

• Optional initialPatch: null | ISchedulePatch

Optional initial patch (e.g. to run the action once immediately).

Implementation of

ICreateScheduleRequest.initialPatch

---

memo

• Optional memo: null | IMemo

Memo and search attributes to attach to the schedule itself.

Implementation of

ICreateScheduleRequest.memo

---

namespace

• namespace: string

The namespace the schedule should be created in.

Implementation of

ICreateScheduleRequest.namespace

---

requestId

• requestId: string

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

Implementation of

ICreateScheduleRequest.requestId

---

schedule

• Optional schedule: null | ISchedule

The schedule spec, policies, action, and initial state.

Implementation of

ICreateScheduleRequest.schedule

---

scheduleId

• scheduleId: string

The id of the new schedule.

Implementation of

ICreateScheduleRequest.scheduleId

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

CreateScheduleRequest searchAttributes.

Implementation of

ICreateScheduleRequest.searchAttributes

Methods

toJSON

▸ toJSON(): Object

Converts this CreateScheduleRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): CreateScheduleRequest

Creates a new CreateScheduleRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	ICreateScheduleRequest	Properties to set

Returns

CreateScheduleRequest

CreateScheduleRequest instance

---

decode

▸ decode(reader, length?): CreateScheduleRequest

Decodes a CreateScheduleRequest 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

CreateScheduleRequest

CreateScheduleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): CreateScheduleRequest

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

Parameters

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

Returns

CreateScheduleRequest

CreateScheduleRequest

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

Parameters

Name	Type	Description
message	ICreateScheduleRequest	CreateScheduleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ICreateScheduleRequest	CreateScheduleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): CreateScheduleRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

CreateScheduleRequest

CreateScheduleRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CreateScheduleRequest

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

Parameters

Name	Type	Description
message	CreateScheduleRequest	CreateScheduleRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object