Skip to main content

Class: CreateScheduleRequest

(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)

Properties​

identity​

identity: string

The identity of the client who initiated this request.

initialPatch?​

optional initialPatch?: $Properties | null

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

memo?​

optional memo?: $Properties | null

Memo and search attributes to attach to the schedule itself.

namespace​

namespace: string

The namespace the schedule should be created in.

requestId​

requestId: string

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

schedule?​

optional schedule?: $Properties | null

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

scheduleId​

scheduleId: string

The id of the new schedule.

searchAttributes?​

optional searchAttributes?: $Properties | null

CreateScheduleRequest searchAttributes.

Methods​

toJSON()​

toJSON(): object

Converts this CreateScheduleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CreateScheduleRequest & $Shape

Creates a new CreateScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

CreateScheduleRequest & $Shape

CreateScheduleRequest instance

Call Signature​

static create(properties?): CreateScheduleRequest

Creates a new CreateScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateScheduleRequest

CreateScheduleRequest instance

decode()​

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

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

CreateScheduleRequest & $Shape

CreateScheduleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CreateScheduleRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CreateScheduleRequest & $Shape

CreateScheduleRequest

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

Parameters​

message​

$Properties

CreateScheduleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CreateScheduleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CreateScheduleRequest

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

Parameters​

object​

Plain object

Returns​

CreateScheduleRequest

CreateScheduleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CreateScheduleRequest

CreateScheduleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object