Skip to main content

Class: PatchScheduleRequest

workflowservice.v1.PatchScheduleRequest

Represents a PatchScheduleRequest.

Implements

Constructors

constructor

new PatchScheduleRequest(properties?)

Constructs a new PatchScheduleRequest.

Parameters

NameTypeDescription
properties?IPatchScheduleRequestProperties to set

Properties

identity

identity: string

PatchScheduleRequest identity.

Implementation of

IPatchScheduleRequest.identity


namespace

namespace: string

PatchScheduleRequest namespace.

Implementation of

IPatchScheduleRequest.namespace


patch

Optional patch: null | ISchedulePatch

PatchScheduleRequest patch.

Implementation of

IPatchScheduleRequest.patch


requestId

requestId: string

PatchScheduleRequest requestId.

Implementation of

IPatchScheduleRequest.requestId


scheduleId

scheduleId: string

PatchScheduleRequest scheduleId.

Implementation of

IPatchScheduleRequest.scheduleId

Methods

toJSON

toJSON(): Object

Converts this PatchScheduleRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): PatchScheduleRequest

Creates a new PatchScheduleRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IPatchScheduleRequestProperties to set

Returns

PatchScheduleRequest

PatchScheduleRequest instance


decode

Static decode(reader, length?): PatchScheduleRequest

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

PatchScheduleRequest

PatchScheduleRequest


decodeDelimited

Static decodeDelimited(reader): PatchScheduleRequest

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

PatchScheduleRequest

PatchScheduleRequest


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): PatchScheduleRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PatchScheduleRequest

PatchScheduleRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PatchScheduleRequest

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

Parameters

NameTypeDescription
messagePatchScheduleRequestPatchScheduleRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object