Skip to main content

Class: GetClusterInfoRequest

workflowservice.v1.GetClusterInfoRequest

Represents a GetClusterInfoRequest.

Implements#

Constructors#

constructor#

new GetClusterInfoRequest(properties?)

Constructs a new GetClusterInfoRequest.

Parameters#

NameType
properties?IGetClusterInfoRequest

Methods#

toJSON#

toJSON(): Object

Converts this GetClusterInfoRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): GetClusterInfoRequest

Decodes a GetClusterInfoRequest message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

GetClusterInfoRequest

GetClusterInfoRequest


decodeDelimited#

Static decodeDelimited(reader): GetClusterInfoRequest

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} 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 {@link temporal.api.workflowservice.v1.GetClusterInfoRequest.verify|verify} messages.

Parameters#

NameTypeDescription
messageIGetClusterInfoRequestGetClusterInfoRequest message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIGetClusterInfoRequestGetClusterInfoRequest message or plain object to encode
writer?Writer-

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


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?IConversionOptions-

Returns#

Object

Plain object