Skip to main content

Class: PublicConnectivityRule

connectivityrule.v1.PublicConnectivityRule

A public connectivity rule allows access to the namespace via the public internet.

Properties

enableStableIps

enableStableIps: boolean

Flag to determine namespace is connected via a predictable set of IPs on public internet temporal:versioning:min_version=v0.15.0

Methods

toJSON

toJSON(): Object

Converts this PublicConnectivityRule to JSON.

Returns

Object

JSON object


create

create(properties?): PublicConnectivityRule & $Properties

Creates a new PublicConnectivityRule instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

PublicConnectivityRule & $Properties

PublicConnectivityRule instance

create(properties?): PublicConnectivityRule

Parameters

NameType
properties?$Properties

Returns

PublicConnectivityRule


decode

decode(reader, length?): PublicConnectivityRule & $Properties

Decodes a PublicConnectivityRule message from the specified reader or buffer.

Parameters

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

Returns

PublicConnectivityRule & $Properties

PublicConnectivityRule

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PublicConnectivityRule & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PublicConnectivityRule & $Properties

PublicConnectivityRule

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 PublicConnectivityRule message. Does not implicitly temporal.api.cloud.connectivityrule.v1.PublicConnectivityRule.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): PublicConnectivityRule

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PublicConnectivityRule

PublicConnectivityRule


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messagePublicConnectivityRulePublicConnectivityRule
options?IConversionOptionsConversion options

Returns

Object

Plain object