Skip to main content

Class: CreateScheduleRequest

workflowservice.v1.CreateScheduleRequest

Represents a CreateScheduleRequest.

Implements

Constructors

constructor

new CreateScheduleRequest(properties?)

Constructs a new CreateScheduleRequest.

Parameters

NameTypeDescription
properties?ICreateScheduleRequestProperties to set

Properties

identity

identity: string

CreateScheduleRequest identity.

Implementation of

ICreateScheduleRequest.identity


initialPatch

Optional initialPatch: null | ISchedulePatch

CreateScheduleRequest initialPatch.

Implementation of

ICreateScheduleRequest.initialPatch


memo

Optional memo: null | IMemo

CreateScheduleRequest memo.

Implementation of

ICreateScheduleRequest.memo


namespace

namespace: string

CreateScheduleRequest namespace.

Implementation of

ICreateScheduleRequest.namespace


requestId

requestId: string

CreateScheduleRequest requestId.

Implementation of

ICreateScheduleRequest.requestId


schedule

Optional schedule: null | ISchedule

CreateScheduleRequest schedule.

Implementation of

ICreateScheduleRequest.schedule


scheduleId

scheduleId: string

CreateScheduleRequest scheduleId.

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

Static create(properties?): CreateScheduleRequest

Creates a new CreateScheduleRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?ICreateScheduleRequestProperties to set

Returns

CreateScheduleRequest

CreateScheduleRequest instance


decode

Static decode(reader, length?): CreateScheduleRequest

Decodes a CreateScheduleRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

CreateScheduleRequest

CreateScheduleRequest


decodeDelimited

Static decodeDelimited(reader): CreateScheduleRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CreateScheduleRequest

CreateScheduleRequest


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageICreateScheduleRequestCreateScheduleRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageICreateScheduleRequestCreateScheduleRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

CreateScheduleRequest

CreateScheduleRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CreateScheduleRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCreateScheduleRequestCreateScheduleRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object