Google Cloud Dms V1 Client - Class SqlIpConfig (2.0.0)

Reference documentation and code samples for the Google Cloud Dms V1 Client class SqlIpConfig.

IP Management configuration.

Generated from protobuf message google.cloud.clouddms.v1.SqlIpConfig

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ enable_ipv4 Google\Protobuf\BoolValue

Whether the instance should be assigned an IPv4 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.

↳ allocated_ip_range string

Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.

↳ require_ssl Google\Protobuf\BoolValue

Whether SSL connections over IP should be enforced or not.

↳ authorized_networks array<Google\Cloud\CloudDms\V1\SqlAclEntry>

The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. 192.168.100.0/24).

getEnableIpv4

Whether the instance should be assigned an IPv4 address or not.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasEnableIpv4

clearEnableIpv4

getEnableIpv4Unwrapped

Returns the unboxed value from getEnableIpv4()

Whether the instance should be assigned an IPv4 address or not.

Returns
Type Description
bool|null

setEnableIpv4

Whether the instance should be assigned an IPv4 address or not.

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

setEnableIpv4Unwrapped

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

Whether the instance should be assigned an IPv4 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

getAllocatedIpRange

Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.

Returns
Type Description
string

setAllocatedIpRange

Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequireSsl

Whether SSL connections over IP should be enforced or not.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasRequireSsl

clearRequireSsl

getRequireSslUnwrapped

Returns the unboxed value from getRequireSsl()

Whether SSL connections over IP should be enforced or not.

Returns
Type Description
bool|null

setRequireSsl

Whether SSL connections over IP should be enforced or not.

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.

Whether SSL connections over IP should be 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. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. 192.168.100.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. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. 192.168.100.0/24).

Parameter
Name Description
var array<Google\Cloud\CloudDms\V1\SqlAclEntry>
Returns
Type Description
$this