Skip to main content

Class: DeleteScheduleRequest

Represents a DeleteScheduleRequest.

Properties​

identity​

identity: string

The identity of the client who initiated this request.

namespace​

namespace: string

The namespace of the schedule to delete.

scheduleId​

scheduleId: string

The id of the schedule to delete.

Methods​

toJSON()​

toJSON(): object

Converts this DeleteScheduleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeleteScheduleRequest & $Properties

Creates a new DeleteScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteScheduleRequest & $Properties

DeleteScheduleRequest instance

Call Signature​

static create(properties?): DeleteScheduleRequest

Creates a new DeleteScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteScheduleRequest

DeleteScheduleRequest instance

decode()​

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

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

DeleteScheduleRequest & $Properties

DeleteScheduleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeleteScheduleRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeleteScheduleRequest & $Properties

DeleteScheduleRequest

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

Parameters​

message​

$Properties

DeleteScheduleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeleteScheduleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteScheduleRequest

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

Parameters​

object​

Plain object

Returns​

DeleteScheduleRequest

DeleteScheduleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeleteScheduleRequest

DeleteScheduleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object