GoogleApi.SQLAdmin.V1beta4.Model.Settings (google_api_sql_admin v0.71.0)
View SourceDatabase instance settings.
Attributes
-
userLabels
(type:map()
, default:nil
) - User-provided labels, represented as a dictionary where each label is a single key value pair. -
replicationType
(type:String.t
, default:nil
) - The type of replication this instance uses. This can be eitherASYNCHRONOUS
orSYNCHRONOUS
. (Deprecated) This property was only applicable to First Generation instances. -
databaseFlags
(type:list(GoogleApi.SQLAdmin.V1beta4.Model.DatabaseFlags.t)
, default:nil
) - The database flags passed to the instance at startup. -
denyMaintenancePeriods
(type:list(GoogleApi.SQLAdmin.V1beta4.Model.DenyMaintenancePeriod.t)
, default:nil
) - Deny maintenance periods -
enableGoogleMlIntegration
(type:boolean()
, default:nil
) - Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. -
deletionProtectionEnabled
(type:boolean()
, default:nil
) - Configuration to protect against accidental instance deletion. -
activationPolicy
(type:String.t
, default:nil
) - 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. -
advancedMachineFeatures
(type:GoogleApi.SQLAdmin.V1beta4.Model.AdvancedMachineFeatures.t
, default:nil
) - Specifies advanced machine configuration for the instances relevant only for SQL Server. -
ipConfiguration
(type:GoogleApi.SQLAdmin.V1beta4.Model.IpConfiguration.t
, default:nil
) - 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. -
kind
(type:String.t
, default:nil
) - This is alwayssql#settings
. -
settingsVersion
(type:String.t
, default:nil
) - 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. -
maintenanceWindow
(type:GoogleApi.SQLAdmin.V1beta4.Model.MaintenanceWindow.t
, default:nil
) - The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. -
connectorEnforcement
(type:String.t
, default:nil
) - 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) andREQUIRED
(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. -
availabilityType
(type:String.t
, default:nil
) - 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. -
insightsConfig
(type:GoogleApi.SQLAdmin.V1beta4.Model.InsightsConfig.t
, default:nil
) - Insights configuration, for now relevant only for Postgres. -
dataDiskSizeGb
(type:String.t
, default:nil
) - The size of data disk, in GB. The data disk size minimum is 10GB. -
retainBackupsOnDelete
(type:boolean()
, default:nil
) - Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. -
backupConfiguration
(type:GoogleApi.SQLAdmin.V1beta4.Model.BackupConfiguration.t
, default:nil
) - The daily backup configuration for the instance. -
dataDiskProvisionedThroughput
(type:String.t
, default:nil
) - Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. -
dataDiskProvisionedIops
(type:String.t
, default:nil
) - Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. -
authorizedGaeApplications
(type:list(String.t)
, default:nil
) - The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. -
edition
(type:String.t
, default:nil
) - Optional. The edition of the instance. -
dataDiskType
(type:String.t
, default:nil
) - The type of data disk:PD_SSD
(default) orPD_HDD
. Not used for First Generation instances. -
databaseReplicationEnabled
(type:boolean()
, default:nil
) - Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. -
storageAutoResizeLimit
(type:String.t
, default:nil
) - The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. -
collation
(type:String.t
, default:nil
) - The name of server Instance collation. -
tier
(type:String.t
, default:nil
) - The tier (or machine type) for this instance, for exampledb-custom-1-3840
. WARNING: Changing this restarts the instance. -
replicationLagMaxSeconds
(type:integer()
, default:nil
) - Optional. Configuration value for recreation of replica after certain replication lag -
locationPreference
(type:GoogleApi.SQLAdmin.V1beta4.Model.LocationPreference.t
, default:nil
) - 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. -
connectionPoolConfig
(type:GoogleApi.SQLAdmin.V1beta4.Model.ConnectionPoolConfig.t
, default:nil
) - Optional. The managed connection pooling configuration for the instance. -
storageAutoResize
(type:boolean()
, default:nil
) - Configuration to increase storage size automatically. The default value is true. -
timeZone
(type:String.t
, default:nil
) - Server timezone, relevant only for Cloud SQL for SQL Server. -
sqlServerAuditConfig
(type:GoogleApi.SQLAdmin.V1beta4.Model.SqlServerAuditConfig.t
, default:nil
) - SQL Server specific audit configuration. -
enableDataplexIntegration
(type:boolean()
, default:nil
) - Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. -
activeDirectoryConfig
(type:GoogleApi.SQLAdmin.V1beta4.Model.SqlActiveDirectoryConfig.t
, default:nil
) - Active Directory configuration, relevant only for Cloud SQL for SQL Server. -
passwordValidationPolicy
(type:GoogleApi.SQLAdmin.V1beta4.Model.PasswordValidationPolicy.t
, default:nil
) - The local user password validation policy of the instance. -
dataCacheConfig
(type:GoogleApi.SQLAdmin.V1beta4.Model.DataCacheConfig.t
, default:nil
) - Configuration for data cache. -
pricingPlan
(type:String.t
, default:nil
) - The pricing plan for this instance. This can be eitherPER_USE
orPACKAGE
. OnlyPER_USE
is supported for Second Generation instances. -
crashSafeReplicationEnabled
(type:boolean()
, default:nil
) - 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.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.SQLAdmin.V1beta4.Model.Settings{ activationPolicy: String.t() | nil, activeDirectoryConfig: GoogleApi.SQLAdmin.V1beta4.Model.SqlActiveDirectoryConfig.t() | nil, advancedMachineFeatures: GoogleApi.SQLAdmin.V1beta4.Model.AdvancedMachineFeatures.t() | nil, authorizedGaeApplications: [String.t()] | nil, availabilityType: String.t() | nil, backupConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.BackupConfiguration.t() | nil, collation: String.t() | nil, connectionPoolConfig: GoogleApi.SQLAdmin.V1beta4.Model.ConnectionPoolConfig.t() | nil, connectorEnforcement: String.t() | nil, crashSafeReplicationEnabled: boolean() | nil, dataCacheConfig: GoogleApi.SQLAdmin.V1beta4.Model.DataCacheConfig.t() | nil, dataDiskProvisionedIops: String.t() | nil, dataDiskProvisionedThroughput: String.t() | nil, dataDiskSizeGb: String.t() | nil, dataDiskType: String.t() | nil, databaseFlags: [GoogleApi.SQLAdmin.V1beta4.Model.DatabaseFlags.t()] | nil, databaseReplicationEnabled: boolean() | nil, deletionProtectionEnabled: boolean() | nil, denyMaintenancePeriods: [GoogleApi.SQLAdmin.V1beta4.Model.DenyMaintenancePeriod.t()] | nil, edition: String.t() | nil, enableDataplexIntegration: boolean() | nil, enableGoogleMlIntegration: boolean() | nil, insightsConfig: GoogleApi.SQLAdmin.V1beta4.Model.InsightsConfig.t() | nil, ipConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.IpConfiguration.t() | nil, kind: String.t() | nil, locationPreference: GoogleApi.SQLAdmin.V1beta4.Model.LocationPreference.t() | nil, maintenanceWindow: GoogleApi.SQLAdmin.V1beta4.Model.MaintenanceWindow.t() | nil, passwordValidationPolicy: GoogleApi.SQLAdmin.V1beta4.Model.PasswordValidationPolicy.t() | nil, pricingPlan: String.t() | nil, replicationLagMaxSeconds: integer() | nil, replicationType: String.t() | nil, retainBackupsOnDelete: boolean() | nil, settingsVersion: String.t() | nil, sqlServerAuditConfig: GoogleApi.SQLAdmin.V1beta4.Model.SqlServerAuditConfig.t() | nil, storageAutoResize: boolean() | nil, storageAutoResizeLimit: String.t() | nil, tier: String.t() | nil, timeZone: String.t() | nil, userLabels: map() | nil }