Reference documentation and code samples for the Google Cloud Vpc Access V1 Client class Connector.
Definition of a Serverless VPC Access connector.
Generated from protobuf message google.cloud.vpcaccess.v1.Connector
Namespace
Google \ Cloud \ VpcAccess \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name in the format |
↳ network |
string
Name of a VPC network. |
↳ ip_cidr_range |
string
The range of internal addresses that follows RFC 4632 notation. Example: |
↳ state |
int
Output only. State of the VPC access connector. |
↳ min_throughput |
int
Minimum throughput of the connector in Mbps. Default and min is 200. |
↳ max_throughput |
int
Maximum throughput of the connector in Mbps. Default is 300, max is 1000. |
↳ connected_projects |
array
Output only. List of projects using the connector. |
↳ subnet |
Google\Cloud\VpcAccess\V1\Connector\Subnet
The subnet in which to house the VPC Access Connector. |
↳ machine_type |
string
Machine type of VM Instance underlying connector. Default is e2-micro |
↳ min_instances |
int
Minimum value of instances in autoscaling group underlying the connector. |
↳ max_instances |
int
Maximum value of instances in autoscaling group underlying the connector. |
getName
The resource name in the format projects/*/locations/*/connectors/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The resource name in the format projects/*/locations/*/connectors/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
Name of a VPC network.
| Returns | |
|---|---|
| Type | Description |
string | |
setNetwork
Name of a VPC network.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpCidrRange
The range of internal addresses that follows RFC 4632 notation.
Example: 10.132.0.0/28.
| Returns | |
|---|---|
| Type | Description |
string | |
setIpCidrRange
The range of internal addresses that follows RFC 4632 notation.
Example: 10.132.0.0/28.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of the VPC access connector.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of the VPC access connector.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinThroughput
Minimum throughput of the connector in Mbps. Default and min is 200.
| Returns | |
|---|---|
| Type | Description |
int | |
setMinThroughput
Minimum throughput of the connector in Mbps. Default and min is 200.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxThroughput
Maximum throughput of the connector in Mbps. Default is 300, max is 1000.
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxThroughput
Maximum throughput of the connector in Mbps. Default is 300, max is 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConnectedProjects
Output only. List of projects using the connector.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setConnectedProjects
Output only. List of projects using the connector.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubnet
The subnet in which to house the VPC Access Connector.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VpcAccess\V1\Connector\Subnet|null | |
hasSubnet
clearSubnet
setSubnet
The subnet in which to house the VPC Access Connector.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VpcAccess\V1\Connector\Subnet
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMachineType
Machine type of VM Instance underlying connector. Default is e2-micro
| Returns | |
|---|---|
| Type | Description |
string | |
setMachineType
Machine type of VM Instance underlying connector. Default is e2-micro
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinInstances
Minimum value of instances in autoscaling group underlying the connector.
| Returns | |
|---|---|
| Type | Description |
int | |
setMinInstances
Minimum value of instances in autoscaling group underlying the connector.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxInstances
Maximum value of instances in autoscaling group underlying the connector.
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxInstances
Maximum value of instances in autoscaling group underlying the connector.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |