Skip to main content

Class: PrivateConnectivityRule

A private connectivity rule allows connections from a specific private vpc only.

Properties​

connectionId​

connectionId: string

Connection id provided to enforce the private connectivity. This is required both by AWS and GCP.

gcpProjectId​

gcpProjectId: string

For GCP private connectivity service, GCP needs both GCP project id and the Private Service Connect Connection IDs AWS only needs the connection_id

region​

region: string

The region of the connectivity rule. This should align with the namespace. Example: "aws-us-west-2"

Methods​

toJSON()​

toJSON(): object

Converts this PrivateConnectivityRule to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PrivateConnectivityRule & $Properties

Creates a new PrivateConnectivityRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PrivateConnectivityRule & $Properties

PrivateConnectivityRule instance

Call Signature​

static create(properties?): PrivateConnectivityRule

Creates a new PrivateConnectivityRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PrivateConnectivityRule

PrivateConnectivityRule instance

decode()​

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

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

PrivateConnectivityRule & $Properties

PrivateConnectivityRule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PrivateConnectivityRule & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PrivateConnectivityRule & $Properties

PrivateConnectivityRule

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

Parameters​

message​

$Properties

PrivateConnectivityRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PrivateConnectivityRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PrivateConnectivityRule

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

PrivateConnectivityRule

PrivateConnectivityRule

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PrivateConnectivityRule

PrivateConnectivityRule

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object