Skip to main content

Class: HighAvailabilitySpec

Represents a HighAvailabilitySpec.

Properties​

disableManagedFailover​

disableManagedFailover: boolean

Flag to disable managed failover for the namespace.

disablePassivePollerForwarding​

disablePassivePollerForwarding: boolean

Flag to disable passive poller forwarding for this namespace. temporal:versioning:min_version=v0.13.0

Methods​

toJSON()​

toJSON(): object

Converts this HighAvailabilitySpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): HighAvailabilitySpec & $Properties

Creates a new HighAvailabilitySpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HighAvailabilitySpec & $Properties

HighAvailabilitySpec instance

Call Signature​

static create(properties?): HighAvailabilitySpec

Creates a new HighAvailabilitySpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HighAvailabilitySpec

HighAvailabilitySpec instance

decode()​

static decode(reader, length?): HighAvailabilitySpec & $Properties

Decodes a HighAvailabilitySpec message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

HighAvailabilitySpec & $Properties

HighAvailabilitySpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): HighAvailabilitySpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

HighAvailabilitySpec & $Properties

HighAvailabilitySpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified HighAvailabilitySpec message. Does not implicitly temporal.api.cloud.namespace.v1.HighAvailabilitySpec.verify|verify messages.

Parameters​

message​

$Properties

HighAvailabilitySpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified HighAvailabilitySpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.HighAvailabilitySpec.verify|verify messages.

Parameters​

message​

$Properties

HighAvailabilitySpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): HighAvailabilitySpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

HighAvailabilitySpec

HighAvailabilitySpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

HighAvailabilitySpec

HighAvailabilitySpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object