Class: DescribeScheduleResponse
workflowservice.v1.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: null | $Properties
Extra schedule state info.
memo
• Optional memo: null | $Properties
The memo and search attributes that the schedule was created with.
schedule
• Optional schedule: null | $Properties
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: null | $Properties
DescribeScheduleResponse searchAttributes.
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeScheduleResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeScheduleResponse & $Shape
Creates a new DescribeScheduleResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
DescribeScheduleResponse & $Shape
DescribeScheduleResponse instance
▸ create(properties?): DescribeScheduleResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DescribeScheduleResponse & $Shape
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 & $Shape
DescribeScheduleResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeScheduleResponse & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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