Class: ScheduleListEntry
ScheduleListEntry is returned by ListSchedules.
Implements
Constructors
constructor
• new ScheduleListEntry(properties?): ScheduleListEntry
Constructs a new ScheduleListEntry.
Parameters
| Name | Type | Description | 
|---|---|---|
| properties? | IScheduleListEntry | Properties to set | 
Returns
Properties
info
• Optional info: null | IScheduleListInfo
ScheduleListEntry info.
Implementation of
memo
• Optional memo: null | IMemo
ScheduleListEntry memo.
Implementation of
scheduleId
• scheduleId: string
ScheduleListEntry scheduleId.
Implementation of
searchAttributes
• Optional searchAttributes: null | ISearchAttributes
ScheduleListEntry searchAttributes.
Implementation of
IScheduleListEntry.searchAttributes
Methods
toJSON
▸ toJSON(): Object
Converts this ScheduleListEntry to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ScheduleListEntry
Creates a new ScheduleListEntry instance using the specified properties.
Parameters
| Name | Type | Description | 
|---|---|---|
| properties? | IScheduleListEntry | Properties to set | 
Returns
ScheduleListEntry instance
decode
▸ decode(reader, length?): ScheduleListEntry
Decodes a ScheduleListEntry 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
ScheduleListEntry
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ScheduleListEntry
Decodes a ScheduleListEntry message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description | 
|---|---|---|
| reader | Uint8Array|Reader | Reader or buffer to decode from | 
Returns
ScheduleListEntry
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 ScheduleListEntry message. Does not implicitly temporal.api.schedule.v1.ScheduleListEntry.verify|verify messages.
Parameters
| Name | Type | Description | 
|---|---|---|
| message | IScheduleListEntry | ScheduleListEntry message or plain object to encode | 
| writer? | Writer | Writer to encode to | 
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ScheduleListEntry message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleListEntry.verify|verify messages.
Parameters
| Name | Type | Description | 
|---|---|---|
| message | IScheduleListEntry | ScheduleListEntry message or plain object to encode | 
| writer? | Writer | Writer to encode to | 
Returns
Writer
Writer
fromObject
▸ fromObject(object): ScheduleListEntry
Creates a ScheduleListEntry message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description | 
|---|---|---|
| object | Object | Plain object | 
Returns
ScheduleListEntry
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ScheduleListEntry
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 ScheduleListEntry message. Also converts values to other types if specified.
Parameters
| Name | Type | Description | 
|---|---|---|
| message | ScheduleListEntry | ScheduleListEntry | 
| options? | IConversionOptions | Conversion options | 
Returns
Object
Plain object