Skip to main content

Class: GetClusterInfoRequest

workflowservice.v1.GetClusterInfoRequest

Represents a GetClusterInfoRequest.

Methods

toJSON

toJSON(): Object

Converts this GetClusterInfoRequest to JSON.

Returns

Object

JSON object


create

create(properties?): GetClusterInfoRequest & $Properties

Creates a new GetClusterInfoRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

GetClusterInfoRequest & $Properties

GetClusterInfoRequest instance

create(properties?): GetClusterInfoRequest

Parameters

NameType
properties?$Properties

Returns

GetClusterInfoRequest


decode

decode(reader, length?): GetClusterInfoRequest & $Properties

Decodes a GetClusterInfoRequest message from the specified reader or buffer.

Parameters

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

Returns

GetClusterInfoRequest & $Properties

GetClusterInfoRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): GetClusterInfoRequest & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetClusterInfoRequest & $Properties

GetClusterInfoRequest

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 GetClusterInfoRequest message. Does not implicitly temporal.api.workflowservice.v1.GetClusterInfoRequest.verify|verify messages.

Parameters

NameTypeDescription
message$PropertiesGetClusterInfoRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesGetClusterInfoRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): GetClusterInfoRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

GetClusterInfoRequest

GetClusterInfoRequest


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageGetClusterInfoRequestGetClusterInfoRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object