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.



3140
3141
3142
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3140

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) 


2960
2961
2962
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2960

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:



2965
2966
2967
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2965

def active_directory_config
  @active_directory_config
end

#advanced_machine_features ⇒ Google::Apis::SqladminV1::AdvancedMachineFeatures

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

Returns:



2970
2971
2972
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2970

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>) 


2976
2977
2978
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2976

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) 


2985
2986
2987
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2985

def availability_type
  @availability_type
end

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

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



2990
2991
2992
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2990

def backup_configuration
  @backup_configuration
end

#collation ⇒ String

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

Returns:

  • (String) 


2995
2996
2997
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2995

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) 


3006
3007
3008
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3006

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) 


3013
3014
3015
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3013

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) 


3019
3020
3021
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3019

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) 


3025
3026
3027
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3025

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:



3030
3031
3032
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3030

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) 


3036
3037
3038
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3036

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) 


3042
3043
3044
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3042

def deletion_protection_enabled
  @deletion_protection_enabled
end

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

Deny maintenance periods Corresponds to the JSON property denyMaintenancePeriods

Returns:



3048
3049
3050
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3048

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:



3054
3055
3056
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3054

def insights_config
  @insights_config
end

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

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



3059
3060
3061
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3059

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


3064
3065
3066
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3064

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:



3071
3072
3073
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3071

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:



3077
3078
3079
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3077

def maintenance_window
  @maintenance_window
end

#password_validation_policy ⇒ Google::Apis::SqladminV1::PasswordValidationPolicy

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

Returns:



3082
3083
3084
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3082

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) 


3088
3089
3090
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3088

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) 


3095
3096
3097
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3095

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) 


3103
3104
3105
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3103

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:



3108
3109
3110
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3108

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) 


3114
3115
3116
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3114

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) 


3121
3122
3123
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3121

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) 


3127
3128
3129
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3127

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) 


3132
3133
3134
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3132

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>) 


3138
3139
3140
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3138

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3145

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_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)
  @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