Class: DescribeScheduleResponse

workflowservice.v1.DescribeScheduleResponse

Represents a DescribeScheduleResponse.

Implements

• IDescribeScheduleResponse

Constructors

constructor

• new DescribeScheduleResponse(properties?): DescribeScheduleResponse

Constructs a new DescribeScheduleResponse.

Parameters

Name	Type	Description
properties?	IDescribeScheduleResponse	Properties to set

Returns

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.

Implementation of

IDescribeScheduleResponse.conflictToken

---

info

• Optional info: null | IScheduleInfo

Extra schedule state info.

Implementation of

IDescribeScheduleResponse.info

---

memo

• Optional memo: null | IMemo

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

Implementation of

IDescribeScheduleResponse.memo

---

schedule

• Optional schedule: null | ISchedule

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

Implementation of

IDescribeScheduleResponse.schedule

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

DescribeScheduleResponse searchAttributes.

Implementation of

IDescribeScheduleResponse.searchAttributes

Methods

toJSON

▸ toJSON(): Object

Converts this DescribeScheduleResponse to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): DescribeScheduleResponse

Creates a new DescribeScheduleResponse instance using the specified properties.

Parameters

Name	Type	Description
properties?	IDescribeScheduleResponse	Properties to set

Returns

DescribeScheduleResponse

DescribeScheduleResponse instance

---

decode

▸ decode(reader, length?): DescribeScheduleResponse

Decodes a DescribeScheduleResponse message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

DescribeScheduleResponse

DescribeScheduleResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): DescribeScheduleResponse

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

DescribeScheduleResponse

DescribeScheduleResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IDescribeScheduleResponse	DescribeScheduleResponse message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IDescribeScheduleResponse	DescribeScheduleResponse message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): DescribeScheduleResponse

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

DescribeScheduleResponse

DescribeScheduleResponse

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeScheduleResponse

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	DescribeScheduleResponse	DescribeScheduleResponse
options?	IConversionOptions	Conversion options

Returns

Object

Plain object