Google Cloud Sql Admin V1 Client - Class IpConfiguration (1.0.0)

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 \ V1

Methods

__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, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
↳ require_ssl Google\Protobuf\BoolValue

Use ssl_mode instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the require_ssl flag.
↳ 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: 157.197.200.0/24).
↳ 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 [a-z]([-a-z0-9]*[a-z0-9])?.
↳ enable_private_path_for_google_cloud_services Google\Protobuf\BoolValue

Controls connectivity to private IP instances from Google services, such as BigQuery.
↳ ssl_mode int

Specify how SSL/TLS is enforced in database connections. If you must use the require_ssl flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false * ssl_mode=ENCRYPTED_ONLY and require_ssl=false * ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED and require_ssl=true For SQL Server: * ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false * ssl_mode=ENCRYPTED_ONLY and require_ssl=true The value of ssl_mode has priority over the value of require_ssl. For example, for the pair ssl_mode=ENCRYPTED_ONLY and require_ssl=false, ssl_mode=ENCRYPTED_ONLY means accept only SSL connections, while require_ssl=false means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect ssl_mode and accepts only SSL connections.
↳ 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

getIpv4EnabledUnwrapped

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

setIpv4EnabledUnwrapped

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

Use ssl_mode instead.

Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the require_ssl flag.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasRequireSsl

clearRequireSsl

getRequireSslUnwrapped

Returns the unboxed value from getRequireSsl()

Use ssl_mode instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the require_ssl flag.

Returns
Type Description
bool|null

setRequireSsl

Use ssl_mode instead.

Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the require_ssl flag.

Parameter
Name Description
var Google\Protobuf\BoolValue
Returns
Type Description
$this

setRequireSslUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Use ssl_mode instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the require_ssl flag.

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

getEnablePrivatePathForGoogleCloudServicesUnwrapped

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

setEnablePrivatePathForGoogleCloudServicesUnwrapped

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

getSslMode

Specify how SSL/TLS is enforced in database connections. If you must use the require_ssl flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL:

  • ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
  • ssl_mode=ENCRYPTED_ONLY and require_ssl=false
  • ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED and require_ssl=true For SQL Server:
  • ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
  • ssl_mode=ENCRYPTED_ONLY and require_ssl=true The value of ssl_mode has priority over the value of require_ssl.

For example, for the pair ssl_mode=ENCRYPTED_ONLY and require_ssl=false, ssl_mode=ENCRYPTED_ONLY means accept only SSL connections, while require_ssl=false means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect ssl_mode and accepts only SSL connections.

Returns
Type Description
int

setSslMode

Specify how SSL/TLS is enforced in database connections. If you must use the require_ssl flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL:

  • ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
  • ssl_mode=ENCRYPTED_ONLY and require_ssl=false
  • ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED and require_ssl=true For SQL Server:
  • ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
  • ssl_mode=ENCRYPTED_ONLY and require_ssl=true The value of ssl_mode has priority over the value of require_ssl.

For example, for the pair ssl_mode=ENCRYPTED_ONLY and require_ssl=false, ssl_mode=ENCRYPTED_ONLY means accept only SSL connections, while require_ssl=false means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect ssl_mode and accepts only SSL connections.

Parameter
Name Description
var int
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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月21日 UTC.