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
Namespace
Google \ Cloud \ CloudDms \ V1Methods
__construct
Constructor.
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).
↳ edition
int
Optional. The edition of the given Cloud SQL instance.
getDatabaseVersion
The database engine type and version.
int
setDatabaseVersion
The database engine type and version.
var
int
$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" }
.
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" }
.
$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 .
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 .
var
string
$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.
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.
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.
$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.
var
int|string|null
$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.
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.
var
int
$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.
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.
$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.
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.
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.
$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.
var
bool|null
$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" }.
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" }.
$this
getDataDiskType
The type of storage: PD_SSD
(default) or PD_HDD
.
int
setDataDiskType
The type of storage: PD_SSD
(default) or PD_HDD
.
var
int
$this
getDataDiskSizeGb
The storage capacity available to the database, in GB.
The minimum (and default) size is 10GB.
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.
int|string|null
setDataDiskSizeGb
The storage capacity available to the database, in GB.
The minimum (and default) size is 10GB.
$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.
var
int|string|null
$this
getZone
The Google Cloud Platform zone where your Cloud SQL database instance is located.
string
setZone
The Google Cloud Platform zone where your Cloud SQL database instance is located.
var
string
$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).
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).
var
string
$this
getSourceId
The Database Migration Service source connection profile ID,
in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID
string
setSourceId
The Database Migration Service source connection profile ID,
in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID
var
string
$this
getRootPassword
Input only. Initial root password.
string
setRootPassword
Input only. Initial root password.
var
string
$this
getRootPasswordSet
Output only. Indicates If this connection profile root password is stored.
bool
setRootPasswordSet
Output only. Indicates If this connection profile root password is stored.
var
bool
$this
getCollation
The Cloud SQL default instance level collation.
string
setCollation
The Cloud SQL default instance level collation.
var
string
$this
getCmekKeyName
The KMS key name used for the csql instance.
string
setCmekKeyName
The KMS key name used for the csql instance.
var
string
$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).
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).
var
int
$this
getEdition
Optional. The edition of the given Cloud SQL instance.
int
setEdition
Optional. The edition of the given Cloud SQL instance.
var
int
$this
