Skip to main content

Class: DescribeScheduleRequest

Represents a DescribeScheduleRequest.

Properties​

namespace​

namespace: string

The namespace of the schedule to describe.

scheduleId​

scheduleId: string

The id of the schedule to describe.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeScheduleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeScheduleRequest & $Properties

Creates a new DescribeScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeScheduleRequest & $Properties

DescribeScheduleRequest instance

Call Signature​

static create(properties?): DescribeScheduleRequest

Creates a new DescribeScheduleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeScheduleRequest

DescribeScheduleRequest instance

decode()​

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

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

DescribeScheduleRequest & $Properties

DescribeScheduleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeScheduleRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeScheduleRequest & $Properties

DescribeScheduleRequest

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

Parameters​

message​

$Properties

DescribeScheduleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeScheduleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeScheduleRequest

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

Parameters​

object​

Plain object

Returns​

DescribeScheduleRequest

DescribeScheduleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeScheduleRequest

DescribeScheduleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object