Skip to main content

Class: ScheduleListEntry

schedule.v1.ScheduleListEntry

ScheduleListEntry is returned by ListSchedules.

Implements

Constructors

constructor

new ScheduleListEntry(properties?): ScheduleListEntry

Constructs a new ScheduleListEntry.

Parameters

NameTypeDescription
properties?IScheduleListEntryProperties to set

Returns

ScheduleListEntry

Properties

info

Optional info: null | IScheduleListInfo

ScheduleListEntry info.

Implementation of

IScheduleListEntry.info


memo

Optional memo: null | IMemo

ScheduleListEntry memo.

Implementation of

IScheduleListEntry.memo


scheduleId

scheduleId: string

ScheduleListEntry scheduleId.

Implementation of

IScheduleListEntry.scheduleId


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

NameTypeDescription
properties?IScheduleListEntryProperties to set

Returns

ScheduleListEntry

ScheduleListEntry instance


decode

decode(reader, length?): ScheduleListEntry

Decodes a ScheduleListEntry message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ScheduleListEntry

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

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ScheduleListEntry

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

NameTypeDescription
messageIScheduleListEntryScheduleListEntry message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIScheduleListEntryScheduleListEntry message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

ScheduleListEntry

ScheduleListEntry


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleListEntry

Parameters

NameTypeDescription
typeUrlPrefix?stringyour 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

NameTypeDescription
messageScheduleListEntryScheduleListEntry
options?IConversionOptionsConversion options

Returns

Object

Plain object