Struct google_api_proto::google::cloud::sql::v1::Settings

pub struct Settings {

    pub settings_version: Option<i64>,
    pub authorized_gae_applications: Vec<String>,
    pub tier: String,
    pub kind: String,
    pub user_labels: BTreeMap<String, String>,
    pub availability_type: i32,
    pub pricing_plan: i32,
    pub replication_type: i32,
    pub storage_auto_resize_limit: Option<i64>,
    pub activation_policy: i32,
    pub ip_configuration: Option<IpConfiguration>,
    pub storage_auto_resize: Option<bool>,
    pub location_preference: Option<LocationPreference>,
    pub database_flags: Vec<DatabaseFlags>,
    pub data_disk_type: i32,
    pub maintenance_window: Option<MaintenanceWindow>,
    pub backup_configuration: Option<BackupConfiguration>,
    pub database_replication_enabled: Option<bool>,
    pub crash_safe_replication_enabled: Option<bool>,
    pub data_disk_size_gb: Option<i64>,
    pub active_directory_config: Option<SqlActiveDirectoryConfig>,
    pub collation: String,
    pub deny_maintenance_periods: Vec<DenyMaintenancePeriod>,
    pub insights_config: Option<InsightsConfig>,
    pub password_validation_policy: Option<PasswordValidationPolicy>,
    pub sql_server_audit_config: Option<SqlServerAuditConfig>,
    pub edition: i32,
    pub connector_enforcement: i32,
    pub deletion_protection_enabled: Option<bool>,
    pub time_zone: String,
    pub advanced_machine_features: Option<AdvancedMachineFeatures>,
    pub data_cache_config: Option<DataCacheConfig>,
    pub enable_google_ml_integration: Option<bool>,
    pub enable_dataplex_integration: Option<bool>,
}

Database instance settings.

Fields

settings_version: Option<i64>

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

authorized_gae_applications: Vec<String>

👎Deprecated

The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

tier: String

The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.

kind: String

This is always sql#settings.

user_labels: BTreeMap<String, String>

User-provided labels, represented as a dictionary where each label is a single key value pair.

availability_type: i32

Availability type. Potential values:

• ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility.
• REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./

For more information, see Overview of the High Availability Configuration.

pricing_plan: i32

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

replication_type: i32

👎Deprecated

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.

storage_auto_resize_limit: Option<i64>

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

activation_policy: i32

The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values:

• ALWAYS: The instance is on, and remains so even in the absence of connection requests.
• NEVER: The instance is off; it is not activated, even if a connection request arrives.

ip_configuration: Option<IpConfiguration>

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.

storage_auto_resize: Option<bool>

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

location_preference: Option<LocationPreference>

The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

database_flags: Vec<DatabaseFlags>

The database flags passed to the instance at startup.

data_disk_type: i32

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

maintenance_window: Option<MaintenanceWindow>

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

backup_configuration: Option<BackupConfiguration>

The daily backup configuration for the instance.

database_replication_enabled: Option<bool>

Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.

crash_safe_replication_enabled: Option<bool>

👎Deprecated

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

data_disk_size_gb: Option<i64>

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

active_directory_config: Option<SqlActiveDirectoryConfig>

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

collation: String

The name of server Instance collation.

deny_maintenance_periods: Vec<DenyMaintenancePeriod>

Deny maintenance periods

insights_config: Option<InsightsConfig>

Insights configuration, for now relevant only for Postgres.

password_validation_policy: Option<PasswordValidationPolicy>

The local user password validation policy of the instance.

sql_server_audit_config: Option<SqlServerAuditConfig>

SQL Server specific audit configuration.

edition: i32

Optional. The edition of the instance.

connector_enforcement: i32

Specifies if connections must use Cloud SQL connectors. Option values include the following: NOT_REQUIRED (Cloud SQL instances can be connected without Cloud SQL Connectors) and REQUIRED (Only allow connections that use Cloud SQL Connectors).

Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.

deletion_protection_enabled: Option<bool>

Configuration to protect against accidental instance deletion.

time_zone: String

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

advanced_machine_features: Option<AdvancedMachineFeatures>

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

data_cache_config: Option<DataCacheConfig>

Configuration for data cache.

enable_google_ml_integration: Option<bool>

Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.

enable_dataplex_integration: Option<bool>

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.

Implementations

impl Settings

pub fn availability_type(&self) -> SqlAvailabilityType

Returns the enum value of availability_type, or the default if the field is set to an invalid enum value.

pub fn set_availability_type(&mut self, value: SqlAvailabilityType)

Sets availability_type to the provided enum value.

pub fn pricing_plan(&self) -> SqlPricingPlan

Returns the enum value of pricing_plan, or the default if the field is set to an invalid enum value.

pub fn set_pricing_plan(&mut self, value: SqlPricingPlan)

Sets pricing_plan to the provided enum value.

pub fn replication_type(&self) -> SqlReplicationType

Returns the enum value of replication_type, or the default if the field is set to an invalid enum value.

pub fn set_replication_type(&mut self, value: SqlReplicationType)

Sets replication_type to the provided enum value.

pub fn activation_policy(&self) -> SqlActivationPolicy

Returns the enum value of activation_policy, or the default if the field is set to an invalid enum value.

pub fn set_activation_policy(&mut self, value: SqlActivationPolicy)

Sets activation_policy to the provided enum value.

pub fn data_disk_type(&self) -> SqlDataDiskType

Returns the enum value of data_disk_type, or the default if the field is set to an invalid enum value.

pub fn set_data_disk_type(&mut self, value: SqlDataDiskType)

Sets data_disk_type to the provided enum value.

pub fn connector_enforcement(&self) -> ConnectorEnforcement

Returns the enum value of connector_enforcement, or the default if the field is set to an invalid enum value.

pub fn set_connector_enforcement(&mut self, value: ConnectorEnforcement)

Sets connector_enforcement to the provided enum value.

pub fn edition(&self) -> Edition

Returns the enum value of edition, or the default if the field is set to an invalid enum value.

pub fn set_edition(&mut self, value: Edition)

Sets edition to the provided enum value.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl Message for Settings

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Settings