Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class IpConfiguration.
IP Management configuration.
Generated from protobuf message google.cloud.sql.v1.IpConfiguration
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ ipv4_enabled |
Google\Protobuf\BoolValue
Whether the instance is assigned a public IP address or not. |
↳ private_network |
string
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, |
↳ require_ssl |
Google\Protobuf\BoolValue
Whether SSL connections over IP are enforced or not. |
↳ authorized_networks |
array<Google\Cloud\Sql\V1\AclEntry>
The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: |
↳ allocated_ip_range |
string
The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression |
↳ enable_private_path_for_google_cloud_services |
Google\Protobuf\BoolValue
Controls connectivity to private IP instances from Google services, such as BigQuery. |
↳ psc_config |
Google\Cloud\Sql\V1\PscConfig
PSC settings for this instance. |
getIpv4Enabled
Whether the instance is assigned a public IP address or not.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasIpv4Enabled
clearIpv4Enabled
getIpv4EnabledValue
Returns the unboxed value from getIpv4Enabled()
Whether the instance is assigned a public IP address or not.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setIpv4Enabled
Whether the instance is assigned a public IP address or not.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setIpv4EnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether the instance is assigned a public IP address or not.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrivateNetwork
The resource link for the VPC network from which the Cloud SQL instance is
accessible for private IP. For example,
/projects/myProject/global/networks/default. This setting can
be updated, but it cannot be removed after it is set.
| Returns | |
|---|---|
| Type | Description |
string | |
setPrivateNetwork
The resource link for the VPC network from which the Cloud SQL instance is
accessible for private IP. For example,
/projects/myProject/global/networks/default. This setting can
be updated, but it cannot be removed after it is set.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequireSsl
Whether SSL connections over IP are enforced or not.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasRequireSsl
clearRequireSsl
getRequireSslValue
Returns the unboxed value from getRequireSsl()
Whether SSL connections over IP are enforced or not.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setRequireSsl
Whether SSL connections over IP are enforced or not.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setRequireSslValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether SSL connections over IP are enforced or not.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAuthorizedNetworks
The list of external networks that are allowed to connect to the instance
using the IP. In 'CIDR' notation, also known as 'slash' notation (for
example: 157.197.200.0/24).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAuthorizedNetworks
The list of external networks that are allowed to connect to the instance
using the IP. In 'CIDR' notation, also known as 'slash' notation (for
example: 157.197.200.0/24).
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Sql\V1\AclEntry>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllocatedIpRange
The name of the allocated ip range for the private ip Cloud SQL instance.
For example: "google-managed-services-default". If set, the instance ip
will be created in the allocated range. The range name must comply with
RFC 1035. Specifically, the name
must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?.
| Returns | |
|---|---|
| Type | Description |
string | |
setAllocatedIpRange
The name of the allocated ip range for the private ip Cloud SQL instance.
For example: "google-managed-services-default". If set, the instance ip
will be created in the allocated range. The range name must comply with
RFC 1035. Specifically, the name
must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnablePrivatePathForGoogleCloudServices
Controls connectivity to private IP instances from Google services, such as BigQuery.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasEnablePrivatePathForGoogleCloudServices
clearEnablePrivatePathForGoogleCloudServices
getEnablePrivatePathForGoogleCloudServicesValue
Returns the unboxed value from getEnablePrivatePathForGoogleCloudServices()
Controls connectivity to private IP instances from Google services, such as BigQuery.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setEnablePrivatePathForGoogleCloudServices
Controls connectivity to private IP instances from Google services, such as BigQuery.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setEnablePrivatePathForGoogleCloudServicesValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Controls connectivity to private IP instances from Google services, such as BigQuery.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPscConfig
PSC settings for this instance.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Sql\V1\PscConfig|null | |
hasPscConfig
clearPscConfig
setPscConfig
PSC settings for this instance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Sql\V1\PscConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |