Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class Settings.
Database instance settings.
Generated from protobuf message google.cloud.sql.v1.Settings
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ settings_version
Google\Protobuf\Int64Value
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
↳ authorized_gae_applications
array
The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
↳ tier
string
The tier (or machine type) for this instance, for example db-custom-1-3840
. WARNING: Changing this restarts the instance.
↳ kind
string
This is always sql#settings
.
↳ user_labels
array| Google\Protobuf\Internal\MapField
User-provided labels, represented as a dictionary where each label is a single key value pair.
↳ availability_type
int
Availability type. Potential values: * ZONAL
: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL
: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration
.
↳ pricing_plan
int
The pricing plan for this instance. This can be either PER_USE
or PACKAGE
. Only PER_USE
is supported for Second Generation instances.
↳ replication_type
int
The type of replication this instance uses. This can be either ASYNCHRONOUS
or SYNCHRONOUS
. (Deprecated) This property was only applicable to First Generation instances.
↳ 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_configuration
Google\Cloud\Sql\V1\IpConfiguration
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 for Second Generation instances.
↳ storage_auto_resize
Google\Protobuf\BoolValue
Configuration to increase storage size automatically. The default value is true.
↳ location_preference
Google\Cloud\Sql\V1\LocationPreference
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
↳ database_flags
↳ data_disk_type
int
The type of data disk: PD_SSD
(default) or PD_HDD
. Not used for First Generation instances.
↳ maintenance_window
Google\Cloud\Sql\V1\MaintenanceWindow
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
↳ backup_configuration
↳ database_replication_enabled
Google\Protobuf\BoolValue
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
↳ crash_safe_replication_enabled
Google\Protobuf\BoolValue
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
↳ data_disk_size_gb
↳ active_directory_config
Google\Cloud\Sql\V1\SqlActiveDirectoryConfig
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
↳ collation
string
The name of server Instance collation.
↳ deny_maintenance_periods
↳ insights_config
↳ password_validation_policy
Google\Cloud\Sql\V1\PasswordValidationPolicy
The local user password validation policy of the instance.
↳ sql_server_audit_config
↳ edition
int
Optional. The edition of the instance.
↳ connector_enforcement
int
Specifies if connections must use Cloud SQL connectors. Option values include the following: NOT_REQUIRED
(Cloud SQL instances can be connected without Cloud SQL Connectors) and REQUIRED
(Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
↳ deletion_protection_enabled
↳ time_zone
string
Server timezone, relevant only for Cloud SQL for SQL Server.
↳ advanced_machine_features
Google\Cloud\Sql\V1\AdvancedMachineFeatures
Specifies advance machine configuration for the instance relevant only for SQL Server.
↳ data_cache_config
getSettingsVersion
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
hasSettingsVersion
clearSettingsVersion
getSettingsVersionValue
Returns the unboxed value from getSettingsVersion()
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
int|string|null
setSettingsVersion
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
$this
setSettingsVersionValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
var
int|string|null
$this
getAuthorizedGaeApplications
The App Engine app IDs that can access this instance.
(Deprecated) Applied to First Generation instances only.
setAuthorizedGaeApplications
The App Engine app IDs that can access this instance.
(Deprecated) Applied to First Generation instances only.
var
string[]
$this
getTier
The tier (or machine type) for this instance, for example db-custom-1-3840
. WARNING: Changing this restarts the instance.
string
setTier
The tier (or machine type) for this instance, for example db-custom-1-3840
. WARNING: Changing this restarts the instance.
var
string
$this
getKind
This is always sql#settings
.
string
setKind
This is always sql#settings
.
var
string
$this
getUserLabels
User-provided labels, represented as a dictionary where each label is a single key value pair.
setUserLabels
User-provided labels, represented as a dictionary where each label is a single key value pair.
$this
getAvailabilityType
Availability type. Potential values:
-
ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. -
REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration .
int
setAvailabilityType
Availability type. Potential values:
-
ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. -
REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration .
var
int
$this
getPricingPlan
The pricing plan for this instance. This can be either PER_USE
or PACKAGE
. Only PER_USE
is supported for Second Generation instances.
int
setPricingPlan
The pricing plan for this instance. This can be either PER_USE
or PACKAGE
. Only PER_USE
is supported for Second Generation instances.
var
int
$this
getReplicationType
The type of replication this instance uses. This can be either ASYNCHRONOUS
or SYNCHRONOUS
. (Deprecated) This property was only
applicable to First Generation instances.
int
setReplicationType
The type of replication this instance uses. This can be either ASYNCHRONOUS
or SYNCHRONOUS
. (Deprecated) This property was only
applicable to First Generation instances.
var
int
$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
getIpConfiguration
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 for Second Generation instances.
hasIpConfiguration
clearIpConfiguration
setIpConfiguration
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 for Second Generation instances.
$this
getStorageAutoResize
Configuration to increase storage size automatically. The default value is true.
hasStorageAutoResize
clearStorageAutoResize
getStorageAutoResizeValue
Returns the unboxed value from getStorageAutoResize()
Configuration to increase storage size automatically. The default value is true.
bool|null
setStorageAutoResize
Configuration to increase storage size automatically. The default value is true.
$this
setStorageAutoResizeValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Configuration to increase storage size automatically. The default value is true.
var
bool|null
$this
getLocationPreference
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
hasLocationPreference
clearLocationPreference
setLocationPreference
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
$this
getDatabaseFlags
The database flags passed to the instance at startup.
setDatabaseFlags
The database flags passed to the instance at startup.
$this
getDataDiskType
The type of data disk: PD_SSD
(default) or PD_HDD
. Not used for
First Generation instances.
int
setDataDiskType
The type of data disk: PD_SSD
(default) or PD_HDD
. Not used for
First Generation instances.
var
int
$this
getMaintenanceWindow
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
hasMaintenanceWindow
clearMaintenanceWindow
setMaintenanceWindow
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
$this
getBackupConfiguration
The daily backup configuration for the instance.
hasBackupConfiguration
clearBackupConfiguration
setBackupConfiguration
The daily backup configuration for the instance.
$this
getDatabaseReplicationEnabled
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
hasDatabaseReplicationEnabled
clearDatabaseReplicationEnabled
getDatabaseReplicationEnabledValue
Returns the unboxed value from getDatabaseReplicationEnabled()
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
bool|null
setDatabaseReplicationEnabled
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
$this
setDatabaseReplicationEnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
var
bool|null
$this
getCrashSafeReplicationEnabled
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
hasCrashSafeReplicationEnabled
clearCrashSafeReplicationEnabled
getCrashSafeReplicationEnabledValue
Returns the unboxed value from getCrashSafeReplicationEnabled()
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
bool|null
setCrashSafeReplicationEnabled
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
$this
setCrashSafeReplicationEnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
var
bool|null
$this
getDataDiskSizeGb
The size of data disk, in GB. The data disk size minimum is 10GB.
hasDataDiskSizeGb
clearDataDiskSizeGb
getDataDiskSizeGbValue
Returns the unboxed value from getDataDiskSizeGb()
The size of data disk, in GB. The data disk size minimum is 10GB.
int|string|null
setDataDiskSizeGb
The size of data disk, in GB. The data disk size minimum is 10GB.
$this
setDataDiskSizeGbValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
The size of data disk, in GB. The data disk size minimum is 10GB.
var
int|string|null
$this
getActiveDirectoryConfig
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
hasActiveDirectoryConfig
clearActiveDirectoryConfig
setActiveDirectoryConfig
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
$this
getCollation
The name of server Instance collation.
string
setCollation
The name of server Instance collation.
var
string
$this
getDenyMaintenancePeriods
Deny maintenance periods
setDenyMaintenancePeriods
Deny maintenance periods
$this
getInsightsConfig
Insights configuration, for now relevant only for Postgres.
hasInsightsConfig
clearInsightsConfig
setInsightsConfig
Insights configuration, for now relevant only for Postgres.
$this
getPasswordValidationPolicy
The local user password validation policy of the instance.
hasPasswordValidationPolicy
clearPasswordValidationPolicy
setPasswordValidationPolicy
The local user password validation policy of the instance.
$this
getSqlServerAuditConfig
SQL Server specific audit configuration.
hasSqlServerAuditConfig
clearSqlServerAuditConfig
setSqlServerAuditConfig
SQL Server specific audit configuration.
$this
getEdition
Optional. The edition of the instance.
int
setEdition
Optional. The edition of the instance.
var
int
$this
getConnectorEnforcement
Specifies if connections must use Cloud SQL connectors.
Option values include the following: NOT_REQUIRED
(Cloud SQL instances
can be connected without Cloud SQL
Connectors) and REQUIRED
(Only allow connections that use Cloud SQL
Connectors).
Note that using REQUIRED disables all existing authorized networks. If
this field is not specified when creating a new instance, NOT_REQUIRED is
used. If this field is not specified when patching or updating an existing
instance, it is left unchanged in the instance.
int
setConnectorEnforcement
Specifies if connections must use Cloud SQL connectors.
Option values include the following: NOT_REQUIRED
(Cloud SQL instances
can be connected without Cloud SQL
Connectors) and REQUIRED
(Only allow connections that use Cloud SQL
Connectors).
Note that using REQUIRED disables all existing authorized networks. If
this field is not specified when creating a new instance, NOT_REQUIRED is
used. If this field is not specified when patching or updating an existing
instance, it is left unchanged in the instance.
var
int
$this
getDeletionProtectionEnabled
Configuration to protect against accidental instance deletion.
hasDeletionProtectionEnabled
clearDeletionProtectionEnabled
getDeletionProtectionEnabledValue
Returns the unboxed value from getDeletionProtectionEnabled()
Configuration to protect against accidental instance deletion.
bool|null
setDeletionProtectionEnabled
Configuration to protect against accidental instance deletion.
$this
setDeletionProtectionEnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Configuration to protect against accidental instance deletion.
var
bool|null
$this
getTimeZone
Server timezone, relevant only for Cloud SQL for SQL Server.
string
setTimeZone
Server timezone, relevant only for Cloud SQL for SQL Server.
var
string
$this
getAdvancedMachineFeatures
Specifies advance machine configuration for the instance relevant only for SQL Server.
hasAdvancedMachineFeatures
clearAdvancedMachineFeatures
setAdvancedMachineFeatures
Specifies advance machine configuration for the instance relevant only for SQL Server.
$this
getDataCacheConfig
Configuration for data cache.
hasDataCacheConfig
clearDataCacheConfig
setDataCacheConfig
Configuration for data cache.
$this
