Skip to main content

Class: DescribeScheduleResponse

workflowservice.v1.DescribeScheduleResponse

Represents a DescribeScheduleResponse.

Implements

Constructors

constructor

new DescribeScheduleResponse(properties?)

Constructs a new DescribeScheduleResponse.

Parameters

NameTypeDescription
properties?IDescribeScheduleResponseProperties to set

Properties

conflictToken

conflictToken: Uint8Array

DescribeScheduleResponse conflictToken.

Implementation of

IDescribeScheduleResponse.conflictToken


info

Optional info: null | IScheduleInfo

DescribeScheduleResponse info.

Implementation of

IDescribeScheduleResponse.info


memo

Optional memo: null | IMemo

DescribeScheduleResponse memo.

Implementation of

IDescribeScheduleResponse.memo


schedule

Optional schedule: null | ISchedule

DescribeScheduleResponse schedule.

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

Static create(properties?): DescribeScheduleResponse

Creates a new DescribeScheduleResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeScheduleResponseProperties to set

Returns

DescribeScheduleResponse

DescribeScheduleResponse instance


decode

Static decode(reader, length?): DescribeScheduleResponse

Decodes a DescribeScheduleResponse message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

DescribeScheduleResponse

DescribeScheduleResponse


decodeDelimited

Static decodeDelimited(reader): DescribeScheduleResponse

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

DescribeScheduleResponse

DescribeScheduleResponse


encode

Static encode(message, writer?): Writer

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

Parameters

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

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

NameTypeDescription
objectObjectPlain object

Returns

DescribeScheduleResponse

DescribeScheduleResponse


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeScheduleResponse

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageDescribeScheduleResponseDescribeScheduleResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object