Class: Google::Apis::SqladminV1::Settings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/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.



2794
2795
2796
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2794

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) 


2646
2647
2648
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2646

def activation_policy
  @activation_policy
end

#active_directory_config ⇒ Google::Apis::SqladminV1::SqlActiveDirectoryConfig

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

Returns:



2651
2652
2653
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2651

def active_directory_config
  @active_directory_config
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>) 


2657
2658
2659
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2657

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) 


2667
2668
2669
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2667

def availability_type
  @availability_type
end

#backup_configuration ⇒ Google::Apis::SqladminV1::BackupConfiguration

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



2672
2673
2674
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2672

def backup_configuration
  @backup_configuration
end

#collation ⇒ String

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

Returns:

  • (String) 


2677
2678
2679
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2677

def collation
  @collation
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) 


2684
2685
2686
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2684

def crash_safe_replication_enabled
  @crash_safe_replication_enabled
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) 


2690
2691
2692
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2690

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) 


2696
2697
2698
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2696

def data_disk_type
  @data_disk_type
end

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

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

Returns:



2701
2702
2703
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2701

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

Returns:

  • (Boolean) 


2707
2708
2709
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2707

def database_replication_enabled
  @database_replication_enabled
end

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

Deny maintenance periods Corresponds to the JSON property denyMaintenancePeriods

Returns:



2713
2714
2715
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2713

def deny_maintenance_periods
  @deny_maintenance_periods
end

#insights_config ⇒ Google::Apis::SqladminV1::InsightsConfig

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

Returns:



2719
2720
2721
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2719

def insights_config
  @insights_config
end

#ip_configuration ⇒ Google::Apis::SqladminV1::IpConfiguration

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



2724
2725
2726
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2724

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


2729
2730
2731
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2729

def kind
  @kind
end

#location_preference ⇒ Google::Apis::SqladminV1::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:



2736
2737
2738
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2736

def location_preference
  @location_preference
end

#maintenance_window ⇒ Google::Apis::SqladminV1::MaintenanceWindow

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

Returns:



2742
2743
2744
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2742

def maintenance_window
  @maintenance_window
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) 


2748
2749
2750
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2748

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) 


2755
2756
2757
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2755

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) 


2763
2764
2765
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2763

def settings_version
  @settings_version
end

#sql_server_audit_config ⇒ Google::Apis::SqladminV1::SqlServerAuditConfig

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

Returns:



2768
2769
2770
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2768

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) 


2774
2775
2776
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2774

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) 


2781
2782
2783
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2781

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

Returns:

  • (String) 


2786
2787
2788
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2786

def tier
  @tier
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>) 


2792
2793
2794
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2792

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2799

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)
  @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)
  @crash_safe_replication_enabled = args[:crash_safe_replication_enabled] if args.key?(:crash_safe_replication_enabled)
  @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)
  @deny_maintenance_periods = args[:deny_maintenance_periods] if args.key?(:deny_maintenance_periods)
  @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)
  @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)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
end