Skip to main content

Class: DescribeScheduleResponse

Represents a DescribeScheduleResponse.

Properties​

conflictToken​

conflictToken: Uint8Array

This value can be passed back to UpdateSchedule to ensure that the schedule was not modified between a Describe and an Update, which could lead to lost updates and other confusion.

info?​

optional info?: $Properties | null

Extra schedule state info.

memo?​

optional memo?: $Properties | null

The memo and search attributes that the schedule was created with.

schedule?​

optional schedule?: $Properties | null

The complete current schedule details. This may not match the schedule as created because:

  • some types of schedule specs may get compiled into others (e.g. CronString into StructuredCalendarSpec)
  • some unspecified fields may be replaced by defaults
  • some fields in the state are modified automatically
  • the schedule may have been modified by UpdateSchedule or PatchSchedule

searchAttributes?​

optional searchAttributes?: $Properties | null

DescribeScheduleResponse searchAttributes.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeScheduleResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeScheduleResponse & $Shape

Creates a new DescribeScheduleResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

DescribeScheduleResponse & $Shape

DescribeScheduleResponse instance

Call Signature​

static create(properties?): DescribeScheduleResponse

Creates a new DescribeScheduleResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeScheduleResponse

DescribeScheduleResponse instance

decode()​

static decode(reader, length?): DescribeScheduleResponse & $Shape

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

DescribeScheduleResponse & $Shape

DescribeScheduleResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeScheduleResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeScheduleResponse & $Shape

DescribeScheduleResponse

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

Parameters​

message​

$Properties

DescribeScheduleResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeScheduleResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeScheduleResponse

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

Parameters​

object​

Plain object

Returns​

DescribeScheduleResponse

DescribeScheduleResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeScheduleResponse

DescribeScheduleResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object