Skip to main content

Class: FailoverStatus

replication.v1.FailoverStatus

Represents a historical replication status of a Namespace

Properties​

failoverTime​

• Optional failoverTime: null | $Properties

Timestamp when the Cluster switched to the following failover_version


failoverVersion​

• failoverVersion: Long

FailoverStatus failoverVersion.

Methods​

toJSON​

▸ toJSON(): Object

Converts this FailoverStatus to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): FailoverStatus & $Properties

Creates a new FailoverStatus instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

FailoverStatus & $Properties

FailoverStatus instance

▸ create(properties?): FailoverStatus

Parameters​

NameType
properties?$Properties

Returns​

FailoverStatus


decode​

▸ decode(reader, length?): FailoverStatus & $Properties

Decodes a FailoverStatus message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

FailoverStatus & $Properties

FailoverStatus

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): FailoverStatus & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

FailoverStatus & $Properties

FailoverStatus

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

▸ encode(message, writer?): Writer

Encodes the specified FailoverStatus message. Does not implicitly temporal.api.replication.v1.FailoverStatus.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesFailoverStatus message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesFailoverStatus message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): FailoverStatus

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

FailoverStatus

FailoverStatus


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageFailoverStatusFailoverStatus
options?IConversionOptionsConversion options

Returns​

Object

Plain object