Skip to main content

Class: DescribeScheduleRequest

workflowservice.v1.DescribeScheduleRequest

Represents a DescribeScheduleRequest.

Implements

Constructors

constructor

new DescribeScheduleRequest(properties?)

Constructs a new DescribeScheduleRequest.

Parameters

NameTypeDescription
properties?IDescribeScheduleRequestProperties to set

Properties

namespace

namespace: string

DescribeScheduleRequest namespace.

Implementation of

IDescribeScheduleRequest.namespace


scheduleId

scheduleId: string

DescribeScheduleRequest scheduleId.

Implementation of

IDescribeScheduleRequest.scheduleId

Methods

toJSON

toJSON(): Object

Converts this DescribeScheduleRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): DescribeScheduleRequest

Creates a new DescribeScheduleRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeScheduleRequestProperties to set

Returns

DescribeScheduleRequest

DescribeScheduleRequest instance


decode

Static decode(reader, length?): DescribeScheduleRequest

Decodes a DescribeScheduleRequest 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

DescribeScheduleRequest

DescribeScheduleRequest


decodeDelimited

Static decodeDelimited(reader): DescribeScheduleRequest

Decodes a DescribeScheduleRequest 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

DescribeScheduleRequest

DescribeScheduleRequest


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIDescribeScheduleRequestDescribeScheduleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIDescribeScheduleRequestDescribeScheduleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static fromObject(object): DescribeScheduleRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

DescribeScheduleRequest

DescribeScheduleRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeScheduleRequest

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 DescribeScheduleRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageDescribeScheduleRequestDescribeScheduleRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object