Skip to main content

Class: GetClusterInfoRequest

workflowservice.v1.GetClusterInfoRequest

Represents a GetClusterInfoRequest.

Implements​

Constructors​

constructor​

β€’ new GetClusterInfoRequest(properties?)

Constructs a new GetClusterInfoRequest.

Parameters​

NameTypeDescription
properties?IGetClusterInfoRequestProperties to set

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this GetClusterInfoRequest to JSON.

Returns​

Object

JSON object


create​

β–Έ Static create(properties?): GetClusterInfoRequest

Creates a new GetClusterInfoRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?IGetClusterInfoRequestProperties to set

Returns​

GetClusterInfoRequest

GetClusterInfoRequest instance


decode​

β–Έ Static decode(reader, length?): GetClusterInfoRequest

Decodes a GetClusterInfoRequest 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​

GetClusterInfoRequest

GetClusterInfoRequest


decodeDelimited​

β–Έ Static decodeDelimited(reader): GetClusterInfoRequest

Decodes a GetClusterInfoRequest 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​

GetClusterInfoRequest

GetClusterInfoRequest


encode​

β–Έ Static encode(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

β–Έ Static encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

β–Έ Static 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


getTypeUrl​

β–Έ Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetClusterInfoRequest

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

Parameters​

NameTypeDescription
messageGetClusterInfoRequestGetClusterInfoRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object