Google Cloud Dms V1 Client - Class CloudSqlSettings (1.1.0)

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

Settings for creating a Cloud SQL database instance.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ database_version int

The database engine type and version.

↳ user_labels array|Google\Protobuf\Internal\MapField

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

↳ tier string

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

↳ storage_auto_resize_limit Google\Protobuf\Int64Value

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

↳ activation_policy int

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. NEVER: The instance is off; it is not activated, even if a connection request arrives.

↳ ip_config Google\Cloud\CloudDms\V1\SqlIpConfig

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

↳ auto_storage_increase Google\Protobuf\BoolValue

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

↳ database_flags array|Google\Protobuf\Internal\MapField

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

↳ data_disk_type int

The type of storage: PD_SSD (default) or PD_HDD.

↳ data_disk_size_gb Google\Protobuf\Int64Value

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

↳ zone string

The Google Cloud Platform zone where your Cloud SQL database instance is located.

↳ secondary_zone string

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

↳ source_id string

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

↳ root_password string

Input only. Initial root password.

↳ root_password_set bool

Output only. Indicates If this connection profile root password is stored.

↳ collation string

The Cloud SQL default instance level collation.

↳ cmek_key_name string

The KMS key name used for the csql instance.

↳ availability_type int

Optional. Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

getDatabaseVersion

The database engine type and version.

Returns
TypeDescription
int

setDatabaseVersion

The database engine type and version.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUserLabels

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs.

An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setUserLabels

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs.

An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getTier

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances).

For more information, see Cloud SQL Instance Settings.

Returns
TypeDescription
string

setTier

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances).

For more information, see Cloud SQL Instance Settings.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStorageAutoResizeLimit

The maximum size to which storage capacity can be automatically increased.

The default value is 0, which specifies that there is no limit.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasStorageAutoResizeLimit

clearStorageAutoResizeLimit

getStorageAutoResizeLimitValue

Returns the unboxed value from getStorageAutoResizeLimit()

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Returns
TypeDescription
int|string|null

setStorageAutoResizeLimit

The maximum size to which storage capacity can be automatically increased.

The default value is 0, which specifies that there is no limit.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setStorageAutoResizeLimitValue

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

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Parameter
NameDescription
var int|string|null
Returns
TypeDescription
$this

getActivationPolicy

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

Returns
TypeDescription
int

setActivationPolicy

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getIpConfig

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.

The IPv4 address cannot be disabled.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\SqlIpConfig|null

hasIpConfig

clearIpConfig

setIpConfig

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.

The IPv4 address cannot be disabled.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\SqlIpConfig
Returns
TypeDescription
$this

getAutoStorageIncrease

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasAutoStorageIncrease

clearAutoStorageIncrease

getAutoStorageIncreaseValue

Returns the unboxed value from getAutoStorageIncrease()

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

Returns
TypeDescription
bool|null

setAutoStorageIncrease

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setAutoStorageIncreaseValue

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

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$this

getDatabaseFlags

The database flags passed to the Cloud SQL instance at startup.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setDatabaseFlags

The database flags passed to the Cloud SQL instance at startup.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDataDiskType

The type of storage: PD_SSD (default) or PD_HDD.

Returns
TypeDescription
int

setDataDiskType

The type of storage: PD_SSD (default) or PD_HDD.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDataDiskSizeGb

The storage capacity available to the database, in GB.

The minimum (and default) size is 10GB.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasDataDiskSizeGb

clearDataDiskSizeGb

getDataDiskSizeGbValue

Returns the unboxed value from getDataDiskSizeGb()

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

Returns
TypeDescription
int|string|null

setDataDiskSizeGb

The storage capacity available to the database, in GB.

The minimum (and default) size is 10GB.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setDataDiskSizeGbValue

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

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

Parameter
NameDescription
var int|string|null
Returns
TypeDescription
$this

getZone

The Google Cloud Platform zone where your Cloud SQL database instance is located.

Returns
TypeDescription
string

setZone

The Google Cloud Platform zone where your Cloud SQL database instance is located.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSecondaryZone

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

Returns
TypeDescription
string

setSecondaryZone

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceId

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

Returns
TypeDescription
string

setSourceId

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRootPassword

Input only. Initial root password.

Returns
TypeDescription
string

setRootPassword

Input only. Initial root password.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRootPasswordSet

Output only. Indicates If this connection profile root password is stored.

Returns
TypeDescription
bool

setRootPasswordSet

Output only. Indicates If this connection profile root password is stored.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCollation

The Cloud SQL default instance level collation.

Returns
TypeDescription
string

setCollation

The Cloud SQL default instance level collation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCmekKeyName

The KMS key name used for the csql instance.

Returns
TypeDescription
string

setCmekKeyName

The KMS key name used for the csql instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAvailabilityType

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.

  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Returns
TypeDescription
int

setAvailabilityType

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.

  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Parameter
NameDescription
var int
Returns
TypeDescription
$this