Skip to main content

Class: PatchScheduleRequest

Represents a PatchScheduleRequest.

Properties​

identity​

identity: string

The identity of the client who initiated this request.

namespace​

namespace: string

The namespace of the schedule to patch.

patch?​

optional patch?: $Properties | null

PatchScheduleRequest patch.

requestId​

requestId: string

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

scheduleId​

scheduleId: string

The id of the schedule to patch.

Methods​

toJSON()​

toJSON(): object

Converts this PatchScheduleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PatchScheduleRequest & $Properties

Creates a new PatchScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PatchScheduleRequest & $Properties

PatchScheduleRequest instance

Call Signature​

static create(properties?): PatchScheduleRequest

Creates a new PatchScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PatchScheduleRequest

PatchScheduleRequest instance

decode()​

static decode(reader, length?): PatchScheduleRequest & $Properties

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

PatchScheduleRequest & $Properties

PatchScheduleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PatchScheduleRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PatchScheduleRequest & $Properties

PatchScheduleRequest

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

Parameters​

message​

$Properties

PatchScheduleRequest message or plain object to encode

writer?​

Writer

Writer 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​

message​

$Properties

PatchScheduleRequest message or plain object to encode

writer?​

Writer

Writer 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​

object​

Plain object

Returns​

PatchScheduleRequest

PatchScheduleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PatchScheduleRequest

PatchScheduleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object