Skip to main content

Class: UpdateScheduleRequest

workflowservice.v1.UpdateScheduleRequest

Represents an UpdateScheduleRequest.

Implements

Constructors

constructor

new UpdateScheduleRequest(properties?)

Constructs a new UpdateScheduleRequest.

Parameters

NameTypeDescription
properties?IUpdateScheduleRequestProperties to set

Properties

conflictToken

conflictToken: Uint8Array

UpdateScheduleRequest conflictToken.

Implementation of

IUpdateScheduleRequest.conflictToken


identity

identity: string

UpdateScheduleRequest identity.

Implementation of

IUpdateScheduleRequest.identity


namespace

namespace: string

UpdateScheduleRequest namespace.

Implementation of

IUpdateScheduleRequest.namespace


requestId

requestId: string

UpdateScheduleRequest requestId.

Implementation of

IUpdateScheduleRequest.requestId


schedule

Optional schedule: null | ISchedule

UpdateScheduleRequest schedule.

Implementation of

IUpdateScheduleRequest.schedule


scheduleId

scheduleId: string

UpdateScheduleRequest scheduleId.

Implementation of

IUpdateScheduleRequest.scheduleId

Methods

toJSON

toJSON(): Object

Converts this UpdateScheduleRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): UpdateScheduleRequest

Creates a new UpdateScheduleRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IUpdateScheduleRequestProperties to set

Returns

UpdateScheduleRequest

UpdateScheduleRequest instance


decode

Static decode(reader, length?): UpdateScheduleRequest

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

UpdateScheduleRequest

UpdateScheduleRequest


decodeDelimited

Static decodeDelimited(reader): UpdateScheduleRequest

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

UpdateScheduleRequest

UpdateScheduleRequest


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIUpdateScheduleRequestUpdateScheduleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIUpdateScheduleRequestUpdateScheduleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static fromObject(object): UpdateScheduleRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

UpdateScheduleRequest

UpdateScheduleRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UpdateScheduleRequest

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

Parameters

NameTypeDescription
messageUpdateScheduleRequestUpdateScheduleRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object