Skip to main content

Class: DescribeClusterResponse

operatorservice.v1.DescribeClusterResponse

Represents a DescribeClusterResponse.

Implements

Constructors

constructor

new DescribeClusterResponse(properties?)

Constructs a new DescribeClusterResponse.

Parameters

NameTypeDescription
properties?IDescribeClusterResponseProperties to set

Properties

clusterId

clusterId: string

DescribeClusterResponse clusterId.

Implementation of

IDescribeClusterResponse.clusterId


clusterName

clusterName: string

DescribeClusterResponse clusterName.

Implementation of

IDescribeClusterResponse.clusterName


failoverVersionIncrement

failoverVersionIncrement: Long

DescribeClusterResponse failoverVersionIncrement.

Implementation of

IDescribeClusterResponse.failoverVersionIncrement


historyShardCount

historyShardCount: number

DescribeClusterResponse historyShardCount.

Implementation of

IDescribeClusterResponse.historyShardCount


initialFailoverVersion

initialFailoverVersion: Long

DescribeClusterResponse initialFailoverVersion.

Implementation of

IDescribeClusterResponse.initialFailoverVersion


isGlobalNamespaceEnabled

isGlobalNamespaceEnabled: boolean

DescribeClusterResponse isGlobalNamespaceEnabled.

Implementation of

IDescribeClusterResponse.isGlobalNamespaceEnabled


membershipInfo

Optional membershipInfo: null | IMembershipInfo

DescribeClusterResponse membershipInfo.

Implementation of

IDescribeClusterResponse.membershipInfo


persistenceStore

persistenceStore: string

DescribeClusterResponse persistenceStore.

Implementation of

IDescribeClusterResponse.persistenceStore


serverVersion

serverVersion: string

DescribeClusterResponse serverVersion.

Implementation of

IDescribeClusterResponse.serverVersion


supportedClients

supportedClients: Object

DescribeClusterResponse supportedClients.

Index signature

[k: string]: string

Implementation of

IDescribeClusterResponse.supportedClients


versionInfo

Optional versionInfo: null | IVersionInfo

DescribeClusterResponse versionInfo.

Implementation of

IDescribeClusterResponse.versionInfo


visibilityStore

visibilityStore: string

DescribeClusterResponse visibilityStore.

Implementation of

IDescribeClusterResponse.visibilityStore

Methods

toJSON

toJSON(): Object

Converts this DescribeClusterResponse to JSON.

Returns

Object

JSON object


create

Static create(properties?): DescribeClusterResponse

Creates a new DescribeClusterResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeClusterResponseProperties to set

Returns

DescribeClusterResponse

DescribeClusterResponse instance


decode

Static decode(reader, length?): DescribeClusterResponse

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

DescribeClusterResponse

DescribeClusterResponse


decodeDelimited

Static decodeDelimited(reader): DescribeClusterResponse

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

DescribeClusterResponse

DescribeClusterResponse


encode

Static encode(message, writer?): Writer

Encodes the specified DescribeClusterResponse message. Does not implicitly temporal.api.operatorservice.v1.DescribeClusterResponse.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): DescribeClusterResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

DescribeClusterResponse

DescribeClusterResponse


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeClusterResponse

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

Parameters

NameTypeDescription
messageDescribeClusterResponseDescribeClusterResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object