Skip to main content

Class: ConnectivityRuleSpec

The connectivity rule specification passed in on create/update operations.

Properties​

connectionType?​

optional connectionType?: "publicRule" | "privateRule"

ConnectivityRuleSpec connectionType.

privateRule?​

optional privateRule?: $Properties | null

This allows access via specific private vpc.

publicRule?​

optional publicRule?: $Properties | null

This allows access via public internet.

Methods​

toJSON()​

toJSON(): object

Converts this ConnectivityRuleSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ConnectivityRuleSpec & $Shape

Creates a new ConnectivityRuleSpec instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ConnectivityRuleSpec & $Shape

ConnectivityRuleSpec instance

Call Signature​

static create(properties?): ConnectivityRuleSpec

Creates a new ConnectivityRuleSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ConnectivityRuleSpec

ConnectivityRuleSpec instance

decode()​

static decode(reader, length?): ConnectivityRuleSpec & $Shape

Decodes a ConnectivityRuleSpec 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​

ConnectivityRuleSpec & $Shape

ConnectivityRuleSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ConnectivityRuleSpec & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ConnectivityRuleSpec & $Shape

ConnectivityRuleSpec

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

Parameters​

message​

$Properties

ConnectivityRuleSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ConnectivityRuleSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ConnectivityRuleSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ConnectivityRuleSpec

ConnectivityRuleSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ConnectivityRuleSpec

ConnectivityRuleSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object