Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::Settings (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::Settings.

Database instance settings.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accelerated_replica_mode

def accelerated_replica_mode() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

#accelerated_replica_mode=

def accelerated_replica_mode=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.
Returns
  • (::Google::Protobuf::BoolValue) — Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

#activation_policy

def activation_policy() -> ::Google::Cloud::Sql::V1::Settings::SqlActivationPolicy
Returns
  • (::Google::Cloud::Sql::V1::Settings::SqlActivationPolicy) —

    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.

#activation_policy=

def activation_policy=(value) -> ::Google::Cloud::Sql::V1::Settings::SqlActivationPolicy
Parameter
  • value (::Google::Cloud::Sql::V1::Settings::SqlActivationPolicy) —

    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
  • (::Google::Cloud::Sql::V1::Settings::SqlActivationPolicy) —

    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.

#active_directory_config

def active_directory_config() -> ::Google::Cloud::Sql::V1::SqlActiveDirectoryConfig
Returns

#active_directory_config=

def active_directory_config=(value) -> ::Google::Cloud::Sql::V1::SqlActiveDirectoryConfig
Parameter
Returns

#advanced_machine_features

def advanced_machine_features() -> ::Google::Cloud::Sql::V1::AdvancedMachineFeatures
Returns

#advanced_machine_features=

def advanced_machine_features=(value) -> ::Google::Cloud::Sql::V1::AdvancedMachineFeatures
Parameter
Returns

#authorized_gae_applications

def authorized_gae_applications() -> ::Array<::String>
Returns
  • (::Array<::String>) — The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

#authorized_gae_applications=

def authorized_gae_applications=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
Returns
  • (::Array<::String>) — The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

#auto_upgrade_enabled

def auto_upgrade_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.

#auto_upgrade_enabled=

def auto_upgrade_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.
Returns
  • (::Boolean) — Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.

#availability_type

def availability_type() -> ::Google::Cloud::Sql::V1::SqlAvailabilityType
Returns

#availability_type=

def availability_type=(value) -> ::Google::Cloud::Sql::V1::SqlAvailabilityType
Parameter
Returns

#backup_configuration

def backup_configuration() -> ::Google::Cloud::Sql::V1::BackupConfiguration
Returns

#backup_configuration=

def backup_configuration=(value) -> ::Google::Cloud::Sql::V1::BackupConfiguration
Parameter
Returns

#collation

def collation() -> ::String
Returns
  • (::String) — The name of server Instance collation.

#collation=

def collation=(value) -> ::String
Parameter
  • value (::String) — The name of server Instance collation.
Returns
  • (::String) — The name of server Instance collation.

#connection_pool_config

def connection_pool_config() -> ::Google::Cloud::Sql::V1::ConnectionPoolConfig
Returns

#connection_pool_config=

def connection_pool_config=(value) -> ::Google::Cloud::Sql::V1::ConnectionPoolConfig
Parameter
Returns

#connector_enforcement

def connector_enforcement() -> ::Google::Cloud::Sql::V1::Settings::ConnectorEnforcement
Returns
  • (::Google::Cloud::Sql::V1::Settings::ConnectorEnforcement) — 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.

#connector_enforcement=

def connector_enforcement=(value) -> ::Google::Cloud::Sql::V1::Settings::ConnectorEnforcement
Parameter
  • value (::Google::Cloud::Sql::V1::Settings::ConnectorEnforcement) — 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.

Returns
  • (::Google::Cloud::Sql::V1::Settings::ConnectorEnforcement) — 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.

#crash_safe_replication_enabled

def crash_safe_replication_enabled() -> ::Google::Protobuf::BoolValue
Returns
  • (::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.

#crash_safe_replication_enabled=

def crash_safe_replication_enabled=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::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.
Returns
  • (::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_api_access

def data_api_access() -> ::Google::Cloud::Sql::V1::Settings::DataApiAccess
Returns

#data_api_access=

def data_api_access=(value) -> ::Google::Cloud::Sql::V1::Settings::DataApiAccess
Parameter
Returns

#data_cache_config

def data_cache_config() -> ::Google::Cloud::Sql::V1::DataCacheConfig
Returns

#data_cache_config=

def data_cache_config=(value) -> ::Google::Cloud::Sql::V1::DataCacheConfig
Parameter
Returns

#data_disk_provisioned_iops

def data_disk_provisioned_iops() -> ::Integer
Returns
  • (::Integer) — Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.

#data_disk_provisioned_iops=

def data_disk_provisioned_iops=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.
Returns
  • (::Integer) — Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.

#data_disk_provisioned_throughput

def data_disk_provisioned_throughput() -> ::Integer
Returns
  • (::Integer) — Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.

#data_disk_provisioned_throughput=

def data_disk_provisioned_throughput=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.
Returns
  • (::Integer) — Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.

#data_disk_size_gb

def data_disk_size_gb() -> ::Google::Protobuf::Int64Value
Returns

#data_disk_size_gb=

def data_disk_size_gb=(value) -> ::Google::Protobuf::Int64Value
Parameter
Returns

#data_disk_type

def data_disk_type() -> ::Google::Cloud::Sql::V1::SqlDataDiskType
Returns

#data_disk_type=

def data_disk_type=(value) -> ::Google::Cloud::Sql::V1::SqlDataDiskType
Parameter
Returns

#database_flags

def database_flags() -> ::Array<::Google::Cloud::Sql::V1::DatabaseFlags>
Returns

#database_flags=

def database_flags=(value) -> ::Array<::Google::Cloud::Sql::V1::DatabaseFlags>
Parameter
Returns

#database_replication_enabled

def database_replication_enabled() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.

#database_replication_enabled=

def database_replication_enabled=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
Returns
  • (::Google::Protobuf::BoolValue) — Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.

#deletion_protection_enabled

def deletion_protection_enabled() -> ::Google::Protobuf::BoolValue
Returns

#deletion_protection_enabled=

def deletion_protection_enabled=(value) -> ::Google::Protobuf::BoolValue
Parameter
Returns

#deny_maintenance_periods

def deny_maintenance_periods() -> ::Array<::Google::Cloud::Sql::V1::DenyMaintenancePeriod>
Returns

#deny_maintenance_periods=

def deny_maintenance_periods=(value) -> ::Array<::Google::Cloud::Sql::V1::DenyMaintenancePeriod>
Parameter
Returns

#edition

def edition() -> ::Google::Cloud::Sql::V1::Settings::Edition
Returns

#edition=

def edition=(value) -> ::Google::Cloud::Sql::V1::Settings::Edition
Parameter
Returns

#enable_dataplex_integration

def enable_dataplex_integration() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — 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.

#enable_dataplex_integration=

def enable_dataplex_integration=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — 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.
Returns
  • (::Google::Protobuf::BoolValue) — 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.

#enable_google_ml_integration

def enable_google_ml_integration() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — 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 MySQL and Cloud SQL for PostgreSQL instances.

#enable_google_ml_integration=

def enable_google_ml_integration=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — 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 MySQL and Cloud SQL for PostgreSQL instances.
Returns
  • (::Google::Protobuf::BoolValue) — 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 MySQL and Cloud SQL for PostgreSQL instances.

#entraid_config

def entraid_config() -> ::Google::Cloud::Sql::V1::SqlServerEntraIdConfig
Returns

#entraid_config=

def entraid_config=(value) -> ::Google::Cloud::Sql::V1::SqlServerEntraIdConfig
Parameter
Returns

#final_backup_config

def final_backup_config() -> ::Google::Cloud::Sql::V1::FinalBackupConfig
Returns

#final_backup_config=

def final_backup_config=(value) -> ::Google::Cloud::Sql::V1::FinalBackupConfig
Parameter
Returns

#insights_config

def insights_config() -> ::Google::Cloud::Sql::V1::InsightsConfig
Returns

#insights_config=

def insights_config=(value) -> ::Google::Cloud::Sql::V1::InsightsConfig
Parameter
Returns

#ip_configuration

def ip_configuration() -> ::Google::Cloud::Sql::V1::IpConfiguration
Returns
  • (::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.

#ip_configuration=

def ip_configuration=(value) -> ::Google::Cloud::Sql::V1::IpConfiguration
Parameter
  • value (::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.
Returns
  • (::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.

#kind

def kind() -> ::String
Returns
  • (::String) — This is always sql#settings.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — This is always sql#settings.
Returns
  • (::String) — This is always sql#settings.

#location_preference

def location_preference() -> ::Google::Cloud::Sql::V1::LocationPreference
Returns
  • (::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.

#location_preference=

def location_preference=(value) -> ::Google::Cloud::Sql::V1::LocationPreference
Parameter
  • value (::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.
Returns
  • (::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.

#maintenance_window

def maintenance_window() -> ::Google::Cloud::Sql::V1::MaintenanceWindow
Returns

#maintenance_window=

def maintenance_window=(value) -> ::Google::Cloud::Sql::V1::MaintenanceWindow
Parameter
Returns

#password_validation_policy

def password_validation_policy() -> ::Google::Cloud::Sql::V1::PasswordValidationPolicy
Returns

#password_validation_policy=

def password_validation_policy=(value) -> ::Google::Cloud::Sql::V1::PasswordValidationPolicy
Parameter
Returns

#performance_capture_config

def performance_capture_config() -> ::Google::Cloud::Sql::V1::PerformanceCaptureConfig
Returns

#performance_capture_config=

def performance_capture_config=(value) -> ::Google::Cloud::Sql::V1::PerformanceCaptureConfig
Parameter
Returns

#pricing_plan

def pricing_plan() -> ::Google::Cloud::Sql::V1::SqlPricingPlan
Returns

#pricing_plan=

def pricing_plan=(value) -> ::Google::Cloud::Sql::V1::SqlPricingPlan
Parameter
Returns

#read_pool_auto_scale_config

def read_pool_auto_scale_config() -> ::Google::Cloud::Sql::V1::ReadPoolAutoScaleConfig
Returns

#read_pool_auto_scale_config=

def read_pool_auto_scale_config=(value) -> ::Google::Cloud::Sql::V1::ReadPoolAutoScaleConfig
Parameter
Returns

#replication_lag_max_seconds

def replication_lag_max_seconds() -> ::Google::Protobuf::Int32Value
Returns

#replication_lag_max_seconds=

def replication_lag_max_seconds=(value) -> ::Google::Protobuf::Int32Value
Parameter
Returns

#replication_type

def replication_type() -> ::Google::Cloud::Sql::V1::SqlReplicationType
Returns
  • (::Google::Cloud::Sql::V1::SqlReplicationType) — The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.

#replication_type=

def replication_type=(value) -> ::Google::Cloud::Sql::V1::SqlReplicationType
Parameter
  • value (::Google::Cloud::Sql::V1::SqlReplicationType) — The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.
Returns
  • (::Google::Cloud::Sql::V1::SqlReplicationType) — The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.

#retain_backups_on_delete

def retain_backups_on_delete() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — 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.

#retain_backups_on_delete=

def retain_backups_on_delete=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — 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.
Returns
  • (::Google::Protobuf::BoolValue) — 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.

#settings_version

def settings_version() -> ::Google::Protobuf::Int64Value
Returns
  • (::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.

#settings_version=

def settings_version=(value) -> ::Google::Protobuf::Int64Value
Parameter
  • value (::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.
Returns
  • (::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.

#sql_server_audit_config

def sql_server_audit_config() -> ::Google::Cloud::Sql::V1::SqlServerAuditConfig
Returns

#sql_server_audit_config=

def sql_server_audit_config=(value) -> ::Google::Cloud::Sql::V1::SqlServerAuditConfig
Parameter
Returns

#storage_auto_resize

def storage_auto_resize() -> ::Google::Protobuf::BoolValue
Returns

#storage_auto_resize=

def storage_auto_resize=(value) -> ::Google::Protobuf::BoolValue
Parameter
Returns

#storage_auto_resize_limit

def storage_auto_resize_limit() -> ::Google::Protobuf::Int64Value
Returns
  • (::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.

#storage_auto_resize_limit=

def storage_auto_resize_limit=(value) -> ::Google::Protobuf::Int64Value
Parameter
  • value (::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.
Returns
  • (::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.

#tier

def tier() -> ::String
Returns
  • (::String) — The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.

#tier=

def tier=(value) -> ::String
Parameter
  • value (::String) — The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.
Returns
  • (::String) — The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.

#time_zone

def time_zone() -> ::String
Returns
  • (::String) — Server timezone, relevant only for Cloud SQL for SQL Server.

#time_zone=

def time_zone=(value) -> ::String
Parameter
  • value (::String) — Server timezone, relevant only for Cloud SQL for SQL Server.
Returns
  • (::String) — Server timezone, relevant only for Cloud SQL for SQL Server.

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — User-provided labels, represented as a dictionary where each label is a single key value pair.

#user_labels=

def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — User-provided labels, represented as a dictionary where each label is a single key value pair.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — User-provided labels, represented as a dictionary where each label is a single key value pair.