Skip to main content

Class: GetClusterInfoResponse

workflowservice.v1.GetClusterInfoResponse

Represents a GetClusterInfoResponse.

Implements

Constructors

constructor

new GetClusterInfoResponse(properties?)

Constructs a new GetClusterInfoResponse.

Parameters

NameTypeDescription
properties?IGetClusterInfoResponseProperties to set

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


persistenceStore

persistenceStore: string

GetClusterInfoResponse persistenceStore.

Implementation of

IGetClusterInfoResponse.persistenceStore


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


visibilityStore

visibilityStore: string

GetClusterInfoResponse visibilityStore.

Implementation of

IGetClusterInfoResponse.visibilityStore

Methods

toJSON

toJSON(): Object

Converts this GetClusterInfoResponse to JSON.

Returns

Object

JSON object


create

Static create(properties?): GetClusterInfoResponse

Creates a new GetClusterInfoResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IGetClusterInfoResponseProperties to set

Returns

GetClusterInfoResponse

GetClusterInfoResponse instance


decode

Static decode(reader, length?): GetClusterInfoResponse

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

GetClusterInfoResponse

GetClusterInfoResponse


decodeDelimited

Static decodeDelimited(reader): GetClusterInfoResponse

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

GetClusterInfoResponse

GetClusterInfoResponse


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetClusterInfoResponse

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

Parameters

NameTypeDescription
messageGetClusterInfoResponseGetClusterInfoResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object