Class: Google::Cloud::Sql::V1beta4::Settings

Inherits:

Object

Object
Google::Cloud::Sql::V1beta4::Settings

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb

Overview

Database instance settings.

Defined Under Namespace

Modules: ConnectorEnforcement, DataApiAccess, Edition, SqlActivationPolicy Classes: UserLabelsEntry

Instance Attribute Summary collapse

#accelerated_replica_mode ⇒ ::Google::Protobuf::BoolValue
Optional.
#activation_policy ⇒ ::Google::Cloud::Sql::V1beta4::Settings::SqlActivationPolicy
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE.
#active_directory_config ⇒ ::Google::Cloud::Sql::V1beta4::SqlActiveDirectoryConfig
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
#advanced_machine_features ⇒ ::Google::Cloud::Sql::V1beta4::AdvancedMachineFeatures
Specifies advanced machine configuration for the instances relevant only for SQL Server.
#authorized_gae_applications ⇒ ::Array<::String> deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#auto_upgrade_enabled ⇒ ::Boolean
Optional.
#availability_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlAvailabilityType
Availability type.
#backup_configuration ⇒ ::Google::Cloud::Sql::V1beta4::BackupConfiguration
The daily backup configuration for the instance.
#collation ⇒ ::String
The name of server Instance collation.
#connection_pool_config ⇒ ::Google::Cloud::Sql::V1beta4::ConnectionPoolConfig
Optional.
#connector_enforcement ⇒ ::Google::Cloud::Sql::V1beta4::Settings::ConnectorEnforcement
Specifies if connections must use Cloud SQL connectors.
#crash_safe_replication_enabled ⇒ ::Google::Protobuf::BoolValue deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#data_api_access ⇒ ::Google::Cloud::Sql::V1beta4::Settings::DataApiAccess
This parameter controls whether to allow using ExecuteSql API to connect to the instance.
#data_cache_config ⇒ ::Google::Cloud::Sql::V1beta4::DataCacheConfig
Configuration for data cache.
#data_disk_provisioned_iops ⇒ ::Integer
Optional.
#data_disk_provisioned_throughput ⇒ ::Integer
Optional.
#data_disk_size_gb ⇒ ::Google::Protobuf::Int64Value
The size of data disk, in GB.
#data_disk_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlDataDiskType
The type of data disk: PD_SSD (default) or PD_HDD.
#database_flags ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DatabaseFlags>
The database flags passed to the instance at startup.
#database_replication_enabled ⇒ ::Google::Protobuf::BoolValue
Configuration specific to read replica instances.
#deletion_protection_enabled ⇒ ::Google::Protobuf::BoolValue
Configuration to protect against accidental instance deletion.
#deny_maintenance_periods ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DenyMaintenancePeriod>
Deny maintenance periods.
#edition ⇒ ::Google::Cloud::Sql::V1beta4::Settings::Edition
Optional.
#enable_dataplex_integration ⇒ ::Google::Protobuf::BoolValue
Optional.
#enable_google_ml_integration ⇒ ::Google::Protobuf::BoolValue
Optional.
#entraid_config ⇒ ::Google::Cloud::Sql::V1beta4::SqlServerEntraIdConfig
Optional.
#final_backup_config ⇒ ::Google::Cloud::Sql::V1beta4::FinalBackupConfig
Optional.
#insights_config ⇒ ::Google::Cloud::Sql::V1beta4::InsightsConfig
Insights configuration, for now relevant only for Postgres.
#ip_configuration ⇒ ::Google::Cloud::Sql::V1beta4::IpConfiguration
The settings for IP Management.
#kind ⇒ ::String
This is always sql#settings.
#location_preference ⇒ ::Google::Cloud::Sql::V1beta4::LocationPreference
The location preference settings.
#maintenance_window ⇒ ::Google::Cloud::Sql::V1beta4::MaintenanceWindow
The maintenance window for this instance.
#password_validation_policy ⇒ ::Google::Cloud::Sql::V1beta4::PasswordValidationPolicy
The local user password validation policy of the instance.
#performance_capture_config ⇒ ::Google::Cloud::Sql::V1beta4::PerformanceCaptureConfig
Optional.
#pricing_plan ⇒ ::Google::Cloud::Sql::V1beta4::SqlPricingPlan
The pricing plan for this instance.
#read_pool_auto_scale_config ⇒ ::Google::Cloud::Sql::V1beta4::ReadPoolAutoScaleConfig
Optional.
#replication_lag_max_seconds ⇒ ::Google::Protobuf::Int32Value
Optional.
#replication_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlReplicationType deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#retain_backups_on_delete ⇒ ::Google::Protobuf::BoolValue
Optional.
#settings_version ⇒ ::Google::Protobuf::Int64Value
The version of instance settings.
#sql_server_audit_config ⇒ ::Google::Cloud::Sql::V1beta4::SqlServerAuditConfig
SQL Server specific audit configuration.
#storage_auto_resize ⇒ ::Google::Protobuf::BoolValue
Configuration to increase storage size automatically.
#storage_auto_resize_limit ⇒ ::Google::Protobuf::Int64Value
The maximum size to which storage capacity can be automatically increased.
#tier ⇒ ::String
The tier (or machine type) for this instance, for example db-custom-1-3840.
#time_zone ⇒ ::String
Server timezone, relevant only for Cloud SQL for SQL Server.
#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}
User-provided labels, represented as a dictionary where each label is a single key value pair.

Instance Attribute Details

#accelerated_replica_mode ⇒ `::Google::Protobuf::BoolValue`

Returns Optional. Configures whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

Returns:

(::Google::Protobuf::BoolValue) —
Optional. Configures whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#activation_policy ⇒ `::Google::Cloud::Sql::V1beta4::Settings::SqlActivationPolicy`

Returns 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::V1beta4::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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#active_directory_config ⇒ `::Google::Cloud::Sql::V1beta4::SqlActiveDirectoryConfig`

Returns Active Directory configuration, relevant only for Cloud SQL for SQL Server.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlActiveDirectoryConfig) —
Active Directory configuration, relevant only for Cloud SQL for SQL Server.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#advanced_machine_features ⇒ `::Google::Cloud::Sql::V1beta4::AdvancedMachineFeatures`

Returns Specifies advanced machine configuration for the instances relevant only for SQL Server.

Returns:

(::Google::Cloud::Sql::V1beta4::AdvancedMachineFeatures) —
Specifies advanced machine configuration for the instances relevant only for SQL Server.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#authorized_gae_applications ⇒ `::Array<::String>`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#auto_upgrade_enabled ⇒ `::Boolean`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#availability_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlAvailabilityType`

Returns 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.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlAvailabilityType) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#backup_configuration ⇒ `::Google::Cloud::Sql::V1beta4::BackupConfiguration`

Returns The daily backup configuration for the instance.

Returns:

(::Google::Cloud::Sql::V1beta4::BackupConfiguration) —
The daily backup configuration for the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#collation ⇒ `::String`

Returns The name of server Instance collation.

Returns:

(::String) —
The name of server Instance collation.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#connection_pool_config ⇒ `::Google::Cloud::Sql::V1beta4::ConnectionPoolConfig`

Returns Optional. The managed connection pooling configuration for the instance.

Returns:

(::Google::Cloud::Sql::V1beta4::ConnectionPoolConfig) —
Optional. The managed connection pooling configuration for the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#connector_enforcement ⇒ `::Google::Cloud::Sql::V1beta4::Settings::ConnectorEnforcement`

Returns 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::V1beta4::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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#crash_safe_replication_enabled ⇒ `::Google::Protobuf::BoolValue`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#data_api_access ⇒ `::Google::Cloud::Sql::V1beta4::Settings::DataApiAccess`

Returns This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.

Returns:

(::Google::Cloud::Sql::V1beta4::Settings::DataApiAccess) —
This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#data_cache_config ⇒ `::Google::Cloud::Sql::V1beta4::DataCacheConfig`

Returns Configuration for data cache.

Returns:

(::Google::Cloud::Sql::V1beta4::DataCacheConfig) —
Configuration for data cache.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#data_disk_provisioned_iops ⇒ `::Integer`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#data_disk_provisioned_throughput ⇒ `::Integer`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#data_disk_size_gb ⇒ `::Google::Protobuf::Int64Value`

Returns The size of data disk, in GB. The data disk size minimum is 10GB.

Returns:

(::Google::Protobuf::Int64Value) —
The size of data disk, in GB. The data disk size minimum is 10GB.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#data_disk_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlDataDiskType`

Returns The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlDataDiskType) —
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#database_flags ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DatabaseFlags>`

Returns The database flags passed to the instance at startup.

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::DatabaseFlags>) —
The database flags passed to the instance at startup.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#database_replication_enabled ⇒ `::Google::Protobuf::BoolValue`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#deletion_protection_enabled ⇒ `::Google::Protobuf::BoolValue`

Returns Configuration to protect against accidental instance deletion.

Returns:

(::Google::Protobuf::BoolValue) —
Configuration to protect against accidental instance deletion.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#deny_maintenance_periods ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DenyMaintenancePeriod>`

Returns Deny maintenance periods.

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::DenyMaintenancePeriod>) —
Deny maintenance periods

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#edition ⇒ `::Google::Cloud::Sql::V1beta4::Settings::Edition`

Returns Optional. The edition type of the Cloud SQL instance.

Returns:

(::Google::Cloud::Sql::V1beta4::Settings::Edition) —
Optional. The edition type of the Cloud SQL instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#enable_dataplex_integration ⇒ `::Google::Protobuf::BoolValue`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#enable_google_ml_integration ⇒ `::Google::Protobuf::BoolValue`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#entraid_config ⇒ `::Google::Cloud::Sql::V1beta4::SqlServerEntraIdConfig`

Returns Optional. The Microsoft Entra ID configuration for the SQL Server instance.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlServerEntraIdConfig) —
Optional. The Microsoft Entra ID configuration for the SQL Server instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#final_backup_config ⇒ `::Google::Cloud::Sql::V1beta4::FinalBackupConfig`

Returns Optional. The final backup configuration for the instance.

Returns:

(::Google::Cloud::Sql::V1beta4::FinalBackupConfig) —
Optional. The final backup configuration for the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#insights_config ⇒ `::Google::Cloud::Sql::V1beta4::InsightsConfig`

Returns Insights configuration, for now relevant only for Postgres.

Returns:

(::Google::Cloud::Sql::V1beta4::InsightsConfig) —
Insights configuration, for now relevant only for Postgres.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#ip_configuration ⇒ `::Google::Cloud::Sql::V1beta4::IpConfiguration`

Returns 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::V1beta4::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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#kind ⇒ `::String`

Returns This is always sql#settings.

Returns:

(::String) —
This is always sql#settings.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#location_preference ⇒ `::Google::Cloud::Sql::V1beta4::LocationPreference`

Returns 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::V1beta4::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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#maintenance_window ⇒ `::Google::Cloud::Sql::V1beta4::MaintenanceWindow`

Returns The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

Returns:

(::Google::Cloud::Sql::V1beta4::MaintenanceWindow) —
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#password_validation_policy ⇒ `::Google::Cloud::Sql::V1beta4::PasswordValidationPolicy`

Returns The local user password validation policy of the instance.

Returns:

(::Google::Cloud::Sql::V1beta4::PasswordValidationPolicy) —
The local user password validation policy of the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#performance_capture_config ⇒ `::Google::Cloud::Sql::V1beta4::PerformanceCaptureConfig`

Returns Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.

Returns:

(::Google::Cloud::Sql::V1beta4::PerformanceCaptureConfig) —
Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#pricing_plan ⇒ `::Google::Cloud::Sql::V1beta4::SqlPricingPlan`

Returns The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlPricingPlan) —
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#read_pool_auto_scale_config ⇒ `::Google::Cloud::Sql::V1beta4::ReadPoolAutoScaleConfig`

Returns Optional. The read pool auto-scale configuration for the instance.

Returns:

(::Google::Cloud::Sql::V1beta4::ReadPoolAutoScaleConfig) —
Optional. The read pool auto-scale configuration for the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#replication_lag_max_seconds ⇒ `::Google::Protobuf::Int32Value`

Returns Optional. Configuration value for recreation of replica after certain replication lag.

Returns:

(::Google::Protobuf::Int32Value) —
Optional. Configuration value for recreation of replica after certain replication lag.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#replication_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlReplicationType`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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::V1beta4::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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#retain_backups_on_delete ⇒ `::Google::Protobuf::BoolValue`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#settings_version ⇒ `::Google::Protobuf::Int64Value`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#sql_server_audit_config ⇒ `::Google::Cloud::Sql::V1beta4::SqlServerAuditConfig`

Returns SQL Server specific audit configuration.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlServerAuditConfig) —
SQL Server specific audit configuration.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#storage_auto_resize ⇒ `::Google::Protobuf::BoolValue`

Returns Configuration to increase storage size automatically. The default value is true.

Returns:

(::Google::Protobuf::BoolValue) —
Configuration to increase storage size automatically. The default value is true.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#storage_auto_resize_limit ⇒ `::Google::Protobuf::Int64Value`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#tier ⇒ `::String`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#time_zone ⇒ `::String`

Returns Server timezone, relevant only for Cloud SQL for SQL Server.

Returns:

(::String) —
Server timezone, relevant only for Cloud SQL for SQL Server.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

#user_labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns 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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 3499

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance is activated.
  module SqlActivationPolicy
    # Unknown activation plan.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance never starts.
    NEVER = 2

    # The instance starts upon receiving requests.
    ON_DEMAND = 3
  end

  # The list of Cloud SQL editions available to users.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an Enterprise Plus edition.
    ENTERPRISE_PLUS = 3

    # This instance is a Cloud SQL developer edition instance.
    DEVELOPER = 5
  end

  # The options for enforcing Cloud SQL connectors in the instance.
  module ConnectorEnforcement
    # The requirement for Cloud SQL connectors is unknown.
    CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0

    # Do not require Cloud SQL connectors.
    NOT_REQUIRED = 1

    # Require all connections to use Cloud SQL connectors, including the
    # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
    # Note: This disables all existing authorized networks.
    REQUIRED = 2
  end

  # ExecuteSql API's access to the instance.
  module DataApiAccess
    # Unspecified, effectively the same as `DISALLOW_DATA_API`.
    DATA_API_ACCESS_UNSPECIFIED = 0

    # Disallow using ExecuteSql API to connect to the instance.
    DISALLOW_DATA_API = 1

    # Allow using ExecuteSql API to connect to the instance. For private IP
    # instances, this allows authorized users to access the instance from
    # the public internet using ExecuteSql API.
    ALLOW_DATA_API = 2
  end
end

Class: Google::Cloud::Sql::V1beta4::Settings

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#accelerated_replica_mode ⇒ ::Google::Protobuf::BoolValue

#activation_policy ⇒ ::Google::Cloud::Sql::V1beta4::Settings::SqlActivationPolicy

#active_directory_config ⇒ ::Google::Cloud::Sql::V1beta4::SqlActiveDirectoryConfig

#advanced_machine_features ⇒ ::Google::Cloud::Sql::V1beta4::AdvancedMachineFeatures

#authorized_gae_applications ⇒ ::Array<::String>

#auto_upgrade_enabled ⇒ ::Boolean

#availability_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlAvailabilityType

#backup_configuration ⇒ ::Google::Cloud::Sql::V1beta4::BackupConfiguration

#collation ⇒ ::String

#connection_pool_config ⇒ ::Google::Cloud::Sql::V1beta4::ConnectionPoolConfig

#connector_enforcement ⇒ ::Google::Cloud::Sql::V1beta4::Settings::ConnectorEnforcement

#crash_safe_replication_enabled ⇒ ::Google::Protobuf::BoolValue

#data_api_access ⇒ ::Google::Cloud::Sql::V1beta4::Settings::DataApiAccess

#data_cache_config ⇒ ::Google::Cloud::Sql::V1beta4::DataCacheConfig

#data_disk_provisioned_iops ⇒ ::Integer

#data_disk_provisioned_throughput ⇒ ::Integer

#data_disk_size_gb ⇒ ::Google::Protobuf::Int64Value

#data_disk_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlDataDiskType

#database_flags ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DatabaseFlags>

#database_replication_enabled ⇒ ::Google::Protobuf::BoolValue

#deletion_protection_enabled ⇒ ::Google::Protobuf::BoolValue

#deny_maintenance_periods ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DenyMaintenancePeriod>

#edition ⇒ ::Google::Cloud::Sql::V1beta4::Settings::Edition

#enable_dataplex_integration ⇒ ::Google::Protobuf::BoolValue

#enable_google_ml_integration ⇒ ::Google::Protobuf::BoolValue

#entraid_config ⇒ ::Google::Cloud::Sql::V1beta4::SqlServerEntraIdConfig

#final_backup_config ⇒ ::Google::Cloud::Sql::V1beta4::FinalBackupConfig

#insights_config ⇒ ::Google::Cloud::Sql::V1beta4::InsightsConfig

#ip_configuration ⇒ ::Google::Cloud::Sql::V1beta4::IpConfiguration

#kind ⇒ ::String

#location_preference ⇒ ::Google::Cloud::Sql::V1beta4::LocationPreference

#maintenance_window ⇒ ::Google::Cloud::Sql::V1beta4::MaintenanceWindow

#password_validation_policy ⇒ ::Google::Cloud::Sql::V1beta4::PasswordValidationPolicy

#performance_capture_config ⇒ ::Google::Cloud::Sql::V1beta4::PerformanceCaptureConfig

#pricing_plan ⇒ ::Google::Cloud::Sql::V1beta4::SqlPricingPlan

#read_pool_auto_scale_config ⇒ ::Google::Cloud::Sql::V1beta4::ReadPoolAutoScaleConfig

#replication_lag_max_seconds ⇒ ::Google::Protobuf::Int32Value

#replication_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlReplicationType

#retain_backups_on_delete ⇒ ::Google::Protobuf::BoolValue

#settings_version ⇒ ::Google::Protobuf::Int64Value

#sql_server_audit_config ⇒ ::Google::Cloud::Sql::V1beta4::SqlServerAuditConfig

#storage_auto_resize ⇒ ::Google::Protobuf::BoolValue

#storage_auto_resize_limit ⇒ ::Google::Protobuf::Int64Value

#tier ⇒ ::String

#time_zone ⇒ ::String

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

#accelerated_replica_mode ⇒ `::Google::Protobuf::BoolValue`

#activation_policy ⇒ `::Google::Cloud::Sql::V1beta4::Settings::SqlActivationPolicy`

#active_directory_config ⇒ `::Google::Cloud::Sql::V1beta4::SqlActiveDirectoryConfig`

#advanced_machine_features ⇒ `::Google::Cloud::Sql::V1beta4::AdvancedMachineFeatures`

#authorized_gae_applications ⇒ `::Array<::String>`

#auto_upgrade_enabled ⇒ `::Boolean`

#availability_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlAvailabilityType`

#backup_configuration ⇒ `::Google::Cloud::Sql::V1beta4::BackupConfiguration`

#collation ⇒ `::String`

#connection_pool_config ⇒ `::Google::Cloud::Sql::V1beta4::ConnectionPoolConfig`

#connector_enforcement ⇒ `::Google::Cloud::Sql::V1beta4::Settings::ConnectorEnforcement`

#crash_safe_replication_enabled ⇒ `::Google::Protobuf::BoolValue`

#data_api_access ⇒ `::Google::Cloud::Sql::V1beta4::Settings::DataApiAccess`

#data_cache_config ⇒ `::Google::Cloud::Sql::V1beta4::DataCacheConfig`

#data_disk_provisioned_iops ⇒ `::Integer`

#data_disk_provisioned_throughput ⇒ `::Integer`

#data_disk_size_gb ⇒ `::Google::Protobuf::Int64Value`

#data_disk_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlDataDiskType`

#database_flags ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DatabaseFlags>`

#database_replication_enabled ⇒ `::Google::Protobuf::BoolValue`

#deletion_protection_enabled ⇒ `::Google::Protobuf::BoolValue`

#deny_maintenance_periods ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DenyMaintenancePeriod>`

#edition ⇒ `::Google::Cloud::Sql::V1beta4::Settings::Edition`

#enable_dataplex_integration ⇒ `::Google::Protobuf::BoolValue`

#enable_google_ml_integration ⇒ `::Google::Protobuf::BoolValue`

#entraid_config ⇒ `::Google::Cloud::Sql::V1beta4::SqlServerEntraIdConfig`

#final_backup_config ⇒ `::Google::Cloud::Sql::V1beta4::FinalBackupConfig`

#insights_config ⇒ `::Google::Cloud::Sql::V1beta4::InsightsConfig`

#ip_configuration ⇒ `::Google::Cloud::Sql::V1beta4::IpConfiguration`

#kind ⇒ `::String`

#location_preference ⇒ `::Google::Cloud::Sql::V1beta4::LocationPreference`

#maintenance_window ⇒ `::Google::Cloud::Sql::V1beta4::MaintenanceWindow`

#password_validation_policy ⇒ `::Google::Cloud::Sql::V1beta4::PasswordValidationPolicy`

#performance_capture_config ⇒ `::Google::Cloud::Sql::V1beta4::PerformanceCaptureConfig`

#pricing_plan ⇒ `::Google::Cloud::Sql::V1beta4::SqlPricingPlan`

#read_pool_auto_scale_config ⇒ `::Google::Cloud::Sql::V1beta4::ReadPoolAutoScaleConfig`

#replication_lag_max_seconds ⇒ `::Google::Protobuf::Int32Value`

#replication_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlReplicationType`

#retain_backups_on_delete ⇒ `::Google::Protobuf::BoolValue`

#settings_version ⇒ `::Google::Protobuf::Int64Value`

#sql_server_audit_config ⇒ `::Google::Cloud::Sql::V1beta4::SqlServerAuditConfig`

#storage_auto_resize ⇒ `::Google::Protobuf::BoolValue`

#storage_auto_resize_limit ⇒ `::Google::Protobuf::Int64Value`

#tier ⇒ `::String`

#time_zone ⇒ `::String`

#user_labels ⇒ `::Google::Protobuf::Map{::String => ::String}`