Skip to main content

Class: GetClusterInfoResponse

workflowservice.v1.GetClusterInfoResponse

Represents a GetClusterInfoResponse.

Implements#

Constructors#

constructor#

new GetClusterInfoResponse(properties?)

Constructs a new GetClusterInfoResponse.

Parameters#

NameType
properties?IGetClusterInfoResponse

Properties#

clusterId#

clusterId: string

GetClusterInfoResponse clusterId.

Implementation of#

IGetClusterInfoResponse.clusterId


clusterName#

clusterName: string

GetClusterInfoResponse clusterName.

Implementation of#

IGetClusterInfoResponse.clusterName


historyShardCount#

historyShardCount: number

GetClusterInfoResponse historyShardCount.

Implementation of#

IGetClusterInfoResponse.historyShardCount


serverVersion#

serverVersion: string

GetClusterInfoResponse serverVersion.

Implementation of#

IGetClusterInfoResponse.serverVersion


supportedClients#

supportedClients: Object

GetClusterInfoResponse supportedClients.

Index signature#

▪ [k: string]: string

Implementation of#

IGetClusterInfoResponse.supportedClients


versionInfo#

Optional versionInfo: null | IVersionInfo

GetClusterInfoResponse versionInfo.

Implementation of#

IGetClusterInfoResponse.versionInfo

Methods#

toJSON#

toJSON(): Object

Converts this GetClusterInfoResponse to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): GetClusterInfoResponse

Decodes a GetClusterInfoResponse 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#

GetClusterInfoResponse

GetClusterInfoResponse


decodeDelimited#

Static decodeDelimited(reader): GetClusterInfoResponse

Decodes a GetClusterInfoResponse 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#

GetClusterInfoResponse

GetClusterInfoResponse


encode#

Static encode(message, writer?): Writer

Encodes the specified GetClusterInfoResponse message. Does not implicitly {@link temporal.api.workflowservice.v1.GetClusterInfoResponse.verify|verify} messages.

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): GetClusterInfoResponse

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

GetClusterInfoResponse

GetClusterInfoResponse


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageGetClusterInfoResponseGetClusterInfoResponse
options?IConversionOptions-

Returns#

Object

Plain object