Class: Google::Apis::SqladminV1beta4::Settings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1beta4/classes.rb,
lib/google/apis/sqladmin_v1beta4/representations.rb,
lib/google/apis/sqladmin_v1beta4/representations.rb

Overview

Database instance settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Settings

Returns a new instance of Settings.



3708
3709
3710
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3708

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#activation_policy ⇒ String

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. Corresponds to the JSON property activationPolicy

Returns:

  • (String) 


3501
3502
3503
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3501

def activation_policy
  @activation_policy
end

#active_directory_config ⇒ Google::Apis::SqladminV1beta4::SqlActiveDirectoryConfig

Active Directory configuration, relevant only for Cloud SQL for SQL Server. Corresponds to the JSON property activeDirectoryConfig

Returns:



3506
3507
3508
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3506

def active_directory_config
  @active_directory_config
end

#advanced_machine_features ⇒ Google::Apis::SqladminV1beta4::AdvancedMachineFeatures

Specifies options for controlling advanced machine features. Corresponds to the JSON property advancedMachineFeatures

Returns:



3511
3512
3513
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3511

def advanced_machine_features
  @advanced_machine_features
end

#authorized_gae_applications ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3517
3518
3519
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3517

def authorized_gae_applications
  @authorized_gae_applications
end

#availability_type ⇒ String

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. Corresponds to the JSON property availabilityType

Returns:

  • (String) 


3526
3527
3528
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3526

def availability_type
  @availability_type
end

#backup_configuration ⇒ Google::Apis::SqladminV1beta4::BackupConfiguration

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



3531
3532
3533
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3531

def backup_configuration
  @backup_configuration
end

#collation ⇒ String

The name of server Instance collation. Corresponds to the JSON property collation

Returns:

  • (String) 


3536
3537
3538
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3536

def collation
  @collation
end

#connector_enforcement ⇒ String

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. Corresponds to the JSON property connectorEnforcement

Returns:

  • (String) 


3547
3548
3549
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3547

def connector_enforcement
  @connector_enforcement
end

#crash_safe_replication_enabled ⇒ Boolean Also known as: crash_safe_replication_enabled?

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. Corresponds to the JSON property crashSafeReplicationEnabled

Returns:

  • (Boolean) 


3554
3555
3556
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3554

def crash_safe_replication_enabled
  @crash_safe_replication_enabled
end

#data_cache_config ⇒ Google::Apis::SqladminV1beta4::DataCacheConfig

Data cache configurations. Corresponds to the JSON property dataCacheConfig

Returns:



3560
3561
3562
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3560

def data_cache_config
  @data_cache_config
end

#data_disk_size_gb ⇒ Fixnum

The size of data disk, in GB. The data disk size minimum is 10GB. Corresponds to the JSON property dataDiskSizeGb

Returns:

  • (Fixnum) 


3565
3566
3567
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3565

def data_disk_size_gb
  @data_disk_size_gb
end

#data_disk_type ⇒ String

The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances. Corresponds to the JSON property dataDiskType

Returns:

  • (String) 


3571
3572
3573
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3571

def data_disk_type
  @data_disk_type
end

#database_flags ⇒ Array<Google::Apis::SqladminV1beta4::DatabaseFlags>

The database flags passed to the instance at startup. Corresponds to the JSON property databaseFlags

Returns:



3576
3577
3578
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3576

def database_flags
  @database_flags
end

#database_replication_enabled ⇒ Boolean Also known as: database_replication_enabled?

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

Returns:

  • (Boolean) 


3582
3583
3584
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3582

def database_replication_enabled
  @database_replication_enabled
end

#deletion_protection_enabled ⇒ Boolean Also known as: deletion_protection_enabled?

Configuration to protect against accidental instance deletion. Corresponds to the JSON property deletionProtectionEnabled

Returns:

  • (Boolean) 


3588
3589
3590
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3588

def deletion_protection_enabled
  @deletion_protection_enabled
end

#deny_maintenance_periods ⇒ Array<Google::Apis::SqladminV1beta4::DenyMaintenancePeriod>

Deny maintenance periods Corresponds to the JSON property denyMaintenancePeriods

Returns:



3594
3595
3596
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3594

def deny_maintenance_periods
  @deny_maintenance_periods
end

#edition ⇒ String

Optional. The edition of the instance. Corresponds to the JSON property edition

Returns:

  • (String) 


3599
3600
3601
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3599

def edition
  @edition
end

#enable_dataplex_integration ⇒ Boolean Also known as: enable_dataplex_integration?

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. Corresponds to the JSON property enableDataplexIntegration

Returns:

  • (Boolean) 


3606
3607
3608
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3606

def enable_dataplex_integration
  @enable_dataplex_integration
end

#enable_google_ml_integration ⇒ Boolean Also known as: enable_google_ml_integration?

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. Corresponds to the JSON property enableGoogleMlIntegration

Returns:

  • (Boolean) 


3615
3616
3617
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3615

def enable_google_ml_integration
  @enable_google_ml_integration
end

#insights_config ⇒ Google::Apis::SqladminV1beta4::InsightsConfig

Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. Corresponds to the JSON property insightsConfig

Returns:



3622
3623
3624
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3622

def insights_config
  @insights_config
end

#ip_configuration ⇒ Google::Apis::SqladminV1beta4::IpConfiguration

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



3627
3628
3629
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3627

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

This is always sql#settings. Corresponds to the JSON property kind

Returns:

  • (String) 


3632
3633
3634
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3632

def kind
  @kind
end

#location_preference ⇒ Google::Apis::SqladminV1beta4::LocationPreference

Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. Corresponds to the JSON property locationPreference

Returns:



3639
3640
3641
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3639

def location_preference
  @location_preference
end

#maintenance_window ⇒ Google::Apis::SqladminV1beta4::MaintenanceWindow

Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. Corresponds to the JSON property maintenanceWindow

Returns:



3645
3646
3647
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3645

def maintenance_window
  @maintenance_window
end

#password_validation_policy ⇒ Google::Apis::SqladminV1beta4::PasswordValidationPolicy

Database instance local user password validation policy Corresponds to the JSON property passwordValidationPolicy

Returns:



3650
3651
3652
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3650

def password_validation_policy
  @password_validation_policy
end

#pricing_plan ⇒ String

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances. Corresponds to the JSON property pricingPlan

Returns:

  • (String) 


3656
3657
3658
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3656

def pricing_plan
  @pricing_plan
end

#replication_type ⇒ String

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

Returns:

  • (String) 


3663
3664
3665
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3663

def replication_type
  @replication_type
end

#settings_version ⇒ Fixnum

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. Corresponds to the JSON property settingsVersion

Returns:

  • (Fixnum) 


3671
3672
3673
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3671

def settings_version
  @settings_version
end

#sql_server_audit_config ⇒ Google::Apis::SqladminV1beta4::SqlServerAuditConfig

SQL Server specific audit configuration. Corresponds to the JSON property sqlServerAuditConfig

Returns:



3676
3677
3678
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3676

def sql_server_audit_config
  @sql_server_audit_config
end

#storage_auto_resize ⇒ Boolean Also known as: storage_auto_resize?

Configuration to increase storage size automatically. The default value is true. Corresponds to the JSON property storageAutoResize

Returns:

  • (Boolean) 


3682
3683
3684
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3682

def storage_auto_resize
  @storage_auto_resize
end

#storage_auto_resize_limit ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3689
3690
3691
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3689

def storage_auto_resize_limit
  @storage_auto_resize_limit
end

#tier ⇒ String

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

Returns:

  • (String) 


3695
3696
3697
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3695

def tier
  @tier
end

#time_zone ⇒ String

Server timezone, relevant only for Cloud SQL for SQL Server. Corresponds to the JSON property timeZone

Returns:

  • (String) 


3700
3701
3702
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3700

def time_zone
  @time_zone
end

#user_labels ⇒ Hash<String,String>

User-provided labels, represented as a dictionary where each label is a single key value pair. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


3706
3707
3708
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3706

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 3713

def update!(**args)
  @activation_policy = args[:activation_policy] if args.key?(:activation_policy)
  @active_directory_config = args[:active_directory_config] if args.key?(:active_directory_config)
  @advanced_machine_features = args[:advanced_machine_features] if args.key?(:advanced_machine_features)
  @authorized_gae_applications = args[:authorized_gae_applications] if args.key?(:authorized_gae_applications)
  @availability_type = args[:availability_type] if args.key?(:availability_type)
  @backup_configuration = args[:backup_configuration] if args.key?(:backup_configuration)
  @collation = args[:collation] if args.key?(:collation)
  @connector_enforcement = args[:connector_enforcement] if args.key?(:connector_enforcement)
  @crash_safe_replication_enabled = args[:crash_safe_replication_enabled] if args.key?(:crash_safe_replication_enabled)
  @data_cache_config = args[:data_cache_config] if args.key?(:data_cache_config)
  @data_disk_size_gb = args[:data_disk_size_gb] if args.key?(:data_disk_size_gb)
  @data_disk_type = args[:data_disk_type] if args.key?(:data_disk_type)
  @database_flags = args[:database_flags] if args.key?(:database_flags)
  @database_replication_enabled = args[:database_replication_enabled] if args.key?(:database_replication_enabled)
  @deletion_protection_enabled = args[:deletion_protection_enabled] if args.key?(:deletion_protection_enabled)
  @deny_maintenance_periods = args[:deny_maintenance_periods] if args.key?(:deny_maintenance_periods)
  @edition = args[:edition] if args.key?(:edition)
  @enable_dataplex_integration = args[:enable_dataplex_integration] if args.key?(:enable_dataplex_integration)
  @enable_google_ml_integration = args[:enable_google_ml_integration] if args.key?(:enable_google_ml_integration)
  @insights_config = args[:insights_config] if args.key?(:insights_config)
  @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration)
  @kind = args[:kind] if args.key?(:kind)
  @location_preference = args[:location_preference] if args.key?(:location_preference)
  @maintenance_window = args[:maintenance_window] if args.key?(:maintenance_window)
  @password_validation_policy = args[:password_validation_policy] if args.key?(:password_validation_policy)
  @pricing_plan = args[:pricing_plan] if args.key?(:pricing_plan)
  @replication_type = args[:replication_type] if args.key?(:replication_type)
  @settings_version = args[:settings_version] if args.key?(:settings_version)
  @sql_server_audit_config = args[:sql_server_audit_config] if args.key?(:sql_server_audit_config)
  @storage_auto_resize = args[:storage_auto_resize] if args.key?(:storage_auto_resize)
  @storage_auto_resize_limit = args[:storage_auto_resize_limit] if args.key?(:storage_auto_resize_limit)
  @tier = args[:tier] if args.key?(:tier)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
end