Class: PrivateConnectivityRule
connectivityrule.v1.PrivateConnectivityRule
A private connectivity rule allows connections from a specific private vpc only.
Implements
Constructors
constructor
• new PrivateConnectivityRule(properties?): PrivateConnectivityRule
Constructs a new PrivateConnectivityRule.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPrivateConnectivityRule | Properties to set |
Returns
Properties
connectionId
• connectionId: string
Connection id provided to enforce the private connectivity. This is required both by AWS and GCP.
Implementation of
IPrivateConnectivityRule.connectionId
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
Implementation of
IPrivateConnectivityRule.gcpProjectId
region
• region: string
The region of the connectivity rule. This should align with the namespace. Example: "aws-us-west-2"
Implementation of
IPrivateConnectivityRule.region
Methods
toJSON
▸ toJSON(): Object
Converts this PrivateConnectivityRule to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PrivateConnectivityRule
Creates a new PrivateConnectivityRule instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPrivateConnectivityRule | Properties to set |
Returns
PrivateConnectivityRule instance
decode
▸ decode(reader, length?): PrivateConnectivityRule
Decodes a PrivateConnectivityRule message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
PrivateConnectivityRule
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PrivateConnectivityRule
Decodes a PrivateConnectivityRule message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PrivateConnectivityRule
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 PrivateConnectivityRule message. Does not implicitly temporal.api.cloud.connectivityrule.v1.PrivateConnectivityRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPrivateConnectivityRule | PrivateConnectivityRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PrivateConnectivityRule message, length delimited. Does not implicitly temporal.api.cloud.connectivityrule.v1.PrivateConnectivityRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPrivateConnectivityRule | PrivateConnectivityRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PrivateConnectivityRule
Creates a PrivateConnectivityRule message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PrivateConnectivityRule
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PrivateConnectivityRule
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PrivateConnectivityRule message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PrivateConnectivityRule | PrivateConnectivityRule |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object