Settings (Cloud SQL Admin API v1beta4-rev20220623-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sqladmin.model.Settings

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Settings
extends GenericJson
```
Database instance settings.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Settings`	`clone()`
`String`	`getActivationPolicy()` The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE.
`SqlActiveDirectoryConfig`	`getActiveDirectoryConfig()` Active Directory configuration, relevant only for Cloud SQL for SQL Server.
`List<String>`	`getAuthorizedGaeApplications()` The App Engine app IDs that can access this instance.
`String`	`getAvailabilityType()` Availability type.
`BackupConfiguration`	`getBackupConfiguration()` The daily backup configuration for the instance.
`String`	`getCollation()` The name of server Instance collation.
`Boolean`	`getCrashSafeReplicationEnabled()` Configuration specific to read replica instances.
`List<DatabaseFlags>`	`getDatabaseFlags()` The database flags passed to the instance at startup.
`Boolean`	`getDatabaseReplicationEnabled()` Configuration specific to read replica instances.
`Long`	`getDataDiskSizeGb()` The size of data disk, in GB.
`String`	`getDataDiskType()` The type of data disk: `PD_SSD` (default) or `PD_HDD`.
`List<DenyMaintenancePeriod>`	`getDenyMaintenancePeriods()` Deny maintenance periods
`InsightsConfig`	`getInsightsConfig()` Insights configuration, for now relevant only for Postgres.
`IpConfiguration`	`getIpConfiguration()` The settings for IP Management.
`String`	`getKind()` This is always `sql#settings`.
`LocationPreference`	`getLocationPreference()` The location preference settings.
`MaintenanceWindow`	`getMaintenanceWindow()` The maintenance window for this instance.
`PasswordValidationPolicy`	`getPasswordValidationPolicy()` The local user password validation policy of the instance.
`String`	`getPricingPlan()` The pricing plan for this instance.
`String`	`getReplicationType()` The type of replication this instance uses.
`Long`	`getSettingsVersion()` The version of instance settings.
`SqlServerAuditConfig`	`getSqlServerAuditConfig()` SQL Server specific audit configuration.
`Boolean`	`getStorageAutoResize()` Configuration to increase storage size automatically.
`Long`	`getStorageAutoResizeLimit()` The maximum size to which storage capacity can be automatically increased.
`String`	`getTier()` The tier (or machine type) for this instance, for example `db-custom-1-3840`.
`Map<String,String>`	`getUserLabels()` User-provided labels, represented as a dictionary where each label is a single key value pair.
`Settings`	`set(String fieldName, Object value)`
`Settings`	`setActivationPolicy(String activationPolicy)` The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE.
`Settings`	`setActiveDirectoryConfig(SqlActiveDirectoryConfig activeDirectoryConfig)` Active Directory configuration, relevant only for Cloud SQL for SQL Server.
`Settings`	`setAuthorizedGaeApplications(List<String> authorizedGaeApplications)` The App Engine app IDs that can access this instance.
`Settings`	`setAvailabilityType(String availabilityType)` Availability type.
`Settings`	`setBackupConfiguration(BackupConfiguration backupConfiguration)` The daily backup configuration for the instance.
`Settings`	`setCollation(String collation)` The name of server Instance collation.
`Settings`	`setCrashSafeReplicationEnabled(Boolean crashSafeReplicationEnabled)` Configuration specific to read replica instances.
`Settings`	`setDatabaseFlags(List<DatabaseFlags> databaseFlags)` The database flags passed to the instance at startup.
`Settings`	`setDatabaseReplicationEnabled(Boolean databaseReplicationEnabled)` Configuration specific to read replica instances.
`Settings`	`setDataDiskSizeGb(Long dataDiskSizeGb)` The size of data disk, in GB.
`Settings`	`setDataDiskType(String dataDiskType)` The type of data disk: `PD_SSD` (default) or `PD_HDD`.
`Settings`	`setDenyMaintenancePeriods(List<DenyMaintenancePeriod> denyMaintenancePeriods)` Deny maintenance periods
`Settings`	`setInsightsConfig(InsightsConfig insightsConfig)` Insights configuration, for now relevant only for Postgres.
`Settings`	`setIpConfiguration(IpConfiguration ipConfiguration)` The settings for IP Management.
`Settings`	`setKind(String kind)` This is always `sql#settings`.
`Settings`	`setLocationPreference(LocationPreference locationPreference)` The location preference settings.
`Settings`	`setMaintenanceWindow(MaintenanceWindow maintenanceWindow)` The maintenance window for this instance.
`Settings`	`setPasswordValidationPolicy(PasswordValidationPolicy passwordValidationPolicy)` The local user password validation policy of the instance.
`Settings`	`setPricingPlan(String pricingPlan)` The pricing plan for this instance.
`Settings`	`setReplicationType(String replicationType)` The type of replication this instance uses.
`Settings`	`setSettingsVersion(Long settingsVersion)` The version of instance settings.
`Settings`	`setSqlServerAuditConfig(SqlServerAuditConfig sqlServerAuditConfig)` SQL Server specific audit configuration.
`Settings`	`setStorageAutoResize(Boolean storageAutoResize)` Configuration to increase storage size automatically.
`Settings`	`setStorageAutoResizeLimit(Long storageAutoResizeLimit)` The maximum size to which storage capacity can be automatically increased.
`Settings`	`setTier(String tier)` The tier (or machine type) for this instance, for example `db-custom-1-3840`.
`Settings`	`setUserLabels(Map<String,String> userLabels)` User-provided labels, represented as a dictionary where each label is a single key value pair.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - getActivationPolicy
```
public String getActivationPolicy()
```
    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:
    
    value or null for none
  - setActivationPolicy
```
public Settings setActivationPolicy(String activationPolicy)
```
    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.
    
    Parameters:
    
    activationPolicy - activationPolicy or null for none
  - getActiveDirectoryConfig
```
public SqlActiveDirectoryConfig getActiveDirectoryConfig()
```
    Active Directory configuration, relevant only for Cloud SQL for SQL Server.
    
    Returns:
    
    value or null for none
  - setActiveDirectoryConfig
```
public Settings setActiveDirectoryConfig(SqlActiveDirectoryConfig activeDirectoryConfig)
```
    Active Directory configuration, relevant only for Cloud SQL for SQL Server.
    
    Parameters:
    
    activeDirectoryConfig - activeDirectoryConfig or null for none
  - getAuthorizedGaeApplications
```
public List<String> getAuthorizedGaeApplications()
```
    The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
    
    Returns:
    
    value or null for none
  - setAuthorizedGaeApplications
```
public Settings setAuthorizedGaeApplications(List<String> authorizedGaeApplications)
```
    The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
    
    Parameters:
    
    authorizedGaeApplications - authorizedGaeApplications or null for none
  - getAvailabilityType
```
public String getAvailabilityType()
```
    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](https://cloud.google.com/sql/docs/mysql/high- availability).
    
    Returns:
    
    value or null for none
  - setAvailabilityType
```
public Settings setAvailabilityType(String availabilityType)
```
    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](https://cloud.google.com/sql/docs/mysql/high- availability).
    
    Parameters:
    
    availabilityType - availabilityType or null for none
  - getBackupConfiguration
```
public BackupConfiguration getBackupConfiguration()
```
    The daily backup configuration for the instance.
    
    Returns:
    
    value or null for none
  - setBackupConfiguration
```
public Settings setBackupConfiguration(BackupConfiguration backupConfiguration)
```
    The daily backup configuration for the instance.
    
    Parameters:
    
    backupConfiguration - backupConfiguration or null for none
  - getCollation
```
public String getCollation()
```
    The name of server Instance collation.
    
    Returns:
    
    value or null for none
  - setCollation
```
public Settings setCollation(String collation)
```
    The name of server Instance collation.
    
    Parameters:
    
    collation - collation or null for none
  - getCrashSafeReplicationEnabled
```
public Boolean getCrashSafeReplicationEnabled()
```
    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:
    
    value or null for none
  - setCrashSafeReplicationEnabled
```
public Settings setCrashSafeReplicationEnabled(Boolean crashSafeReplicationEnabled)
```
    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.
    
    Parameters:
    
    crashSafeReplicationEnabled - crashSafeReplicationEnabled or null for none
  - getDataDiskSizeGb
```
public Long getDataDiskSizeGb()
```
    The size of data disk, in GB. The data disk size minimum is 10GB.
    
    Returns:
    
    value or null for none
  - setDataDiskSizeGb
```
public Settings setDataDiskSizeGb(Long dataDiskSizeGb)
```
    The size of data disk, in GB. The data disk size minimum is 10GB.
    
    Parameters:
    
    dataDiskSizeGb - dataDiskSizeGb or null for none
  - getDataDiskType
```
public String getDataDiskType()
```
    The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.
    
    Returns:
    
    value or null for none
  - setDataDiskType
```
public Settings setDataDiskType(String dataDiskType)
```
    The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.
    
    Parameters:
    
    dataDiskType - dataDiskType or null for none
  - getDatabaseFlags
```
public List<DatabaseFlags> getDatabaseFlags()
```
    The database flags passed to the instance at startup.
    
    Returns:
    
    value or null for none
  - setDatabaseFlags
```
public Settings setDatabaseFlags(List<DatabaseFlags> databaseFlags)
```
    The database flags passed to the instance at startup.
    
    Parameters:
    
    databaseFlags - databaseFlags or null for none
  - getDatabaseReplicationEnabled
```
public Boolean getDatabaseReplicationEnabled()
```
    Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
    
    Returns:
    
    value or null for none
  - setDatabaseReplicationEnabled
```
public Settings setDatabaseReplicationEnabled(Boolean databaseReplicationEnabled)
```
    Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
    
    Parameters:
    
    databaseReplicationEnabled - databaseReplicationEnabled or null for none
  - getDenyMaintenancePeriods
```
public List<DenyMaintenancePeriod> getDenyMaintenancePeriods()
```
    Deny maintenance periods
    
    Returns:
    
    value or null for none
  - setDenyMaintenancePeriods
```
public Settings setDenyMaintenancePeriods(List<DenyMaintenancePeriod> denyMaintenancePeriods)
```
    Deny maintenance periods
    
    Parameters:
    
    denyMaintenancePeriods - denyMaintenancePeriods or null for none
  - getInsightsConfig
```
public InsightsConfig getInsightsConfig()
```
    Insights configuration, for now relevant only for Postgres.
    
    Returns:
    
    value or null for none
  - setInsightsConfig
```
public Settings setInsightsConfig(InsightsConfig insightsConfig)
```
    Insights configuration, for now relevant only for Postgres.
    
    Parameters:
    
    insightsConfig - insightsConfig or null for none
  - getIpConfiguration
```
public IpConfiguration getIpConfiguration()
```
    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:
    
    value or null for none
  - setIpConfiguration
```
public Settings setIpConfiguration(IpConfiguration 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.
    
    Parameters:
    
    ipConfiguration - ipConfiguration or null for none
  - getKind
```
public String getKind()
```
    This is always `sql#settings`.
    
    Returns:
    
    value or null for none
  - setKind
```
public Settings setKind(String kind)
```
    This is always `sql#settings`.
    
    Parameters:
    
    kind - kind or null for none
  - getLocationPreference
```
public LocationPreference getLocationPreference()
```
    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:
    
    value or null for none
  - setLocationPreference
```
public Settings setLocationPreference(LocationPreference 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.
    
    Parameters:
    
    locationPreference - locationPreference or null for none
  - getMaintenanceWindow
```
public MaintenanceWindow getMaintenanceWindow()
```
    The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
    
    Returns:
    
    value or null for none
  - setMaintenanceWindow
```
public Settings setMaintenanceWindow(MaintenanceWindow maintenanceWindow)
```
    The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
    
    Parameters:
    
    maintenanceWindow - maintenanceWindow or null for none
  - getPasswordValidationPolicy
```
public PasswordValidationPolicy getPasswordValidationPolicy()
```
    The local user password validation policy of the instance.
    
    Returns:
    
    value or null for none
  - setPasswordValidationPolicy
```
public Settings setPasswordValidationPolicy(PasswordValidationPolicy passwordValidationPolicy)
```
    The local user password validation policy of the instance.
    
    Parameters:
    
    passwordValidationPolicy - passwordValidationPolicy or null for none
  - getPricingPlan
```
public String getPricingPlan()
```
    The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
    
    Returns:
    
    value or null for none
  - setPricingPlan
```
public Settings setPricingPlan(String pricingPlan)
```
    The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
    
    Parameters:
    
    pricingPlan - pricingPlan or null for none
  - getReplicationType
```
public String getReplicationType()
```
    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:
    
    value or null for none
  - setReplicationType
```
public Settings setReplicationType(String replicationType)
```
    The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
    
    Parameters:
    
    replicationType - replicationType or null for none
  - getSettingsVersion
```
public Long getSettingsVersion()
```
    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:
    
    value or null for none
  - setSettingsVersion
```
public Settings setSettingsVersion(Long settingsVersion)
```
    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.
    
    Parameters:
    
    settingsVersion - settingsVersion or null for none
  - getSqlServerAuditConfig
```
public SqlServerAuditConfig getSqlServerAuditConfig()
```
    SQL Server specific audit configuration.
    
    Returns:
    
    value or null for none
  - setSqlServerAuditConfig
```
public Settings setSqlServerAuditConfig(SqlServerAuditConfig sqlServerAuditConfig)
```
    SQL Server specific audit configuration.
    
    Parameters:
    
    sqlServerAuditConfig - sqlServerAuditConfig or null for none
  - getStorageAutoResize
```
public Boolean getStorageAutoResize()
```
    Configuration to increase storage size automatically. The default value is true.
    
    Returns:
    
    value or null for none
  - setStorageAutoResize
```
public Settings setStorageAutoResize(Boolean storageAutoResize)
```
    Configuration to increase storage size automatically. The default value is true.
    
    Parameters:
    
    storageAutoResize - storageAutoResize or null for none
  - getStorageAutoResizeLimit
```
public Long getStorageAutoResizeLimit()
```
    The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
    
    Returns:
    
    value or null for none
  - setStorageAutoResizeLimit
```
public Settings setStorageAutoResizeLimit(Long storageAutoResizeLimit)
```
    The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
    
    Parameters:
    
    storageAutoResizeLimit - storageAutoResizeLimit or null for none
  - getTier
```
public String getTier()
```
    The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.
    
    Returns:
    
    value or null for none
  - setTier
```
public Settings setTier(String tier)
```
    The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.
    
    Parameters:
    
    tier - tier or null for none
  - getUserLabels
```
public Map<String,String> getUserLabels()
```
    User-provided labels, represented as a dictionary where each label is a single key value pair.
    
    Returns:
    
    value or null for none
  - setUserLabels
```
public Settings setUserLabels(Map<String,String> userLabels)
```
    User-provided labels, represented as a dictionary where each label is a single key value pair.
    
    Parameters:
    
    userLabels - userLabels or null for none
  - set
```
public Settings set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Settings clone()
```
    Overrides:
    
    clone in class GenericJson

Class Settings

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Settings

Method Detail

getActivationPolicy

setActivationPolicy

getActiveDirectoryConfig

setActiveDirectoryConfig

getAuthorizedGaeApplications

setAuthorizedGaeApplications

getAvailabilityType

setAvailabilityType

getBackupConfiguration

setBackupConfiguration

getCollation

setCollation

getCrashSafeReplicationEnabled

setCrashSafeReplicationEnabled

getDataDiskSizeGb

setDataDiskSizeGb

getDataDiskType

setDataDiskType

getDatabaseFlags

setDatabaseFlags

getDatabaseReplicationEnabled

setDatabaseReplicationEnabled

getDenyMaintenancePeriods

setDenyMaintenancePeriods

getInsightsConfig

setInsightsConfig

getIpConfiguration

setIpConfiguration

getKind

setKind

getLocationPreference

setLocationPreference

getMaintenanceWindow

setMaintenanceWindow

getPasswordValidationPolicy

setPasswordValidationPolicy

getPricingPlan

setPricingPlan

getReplicationType

setReplicationType

getSettingsVersion

setSettingsVersion

getSqlServerAuditConfig

setSqlServerAuditConfig

getStorageAutoResize

setStorageAutoResize

getStorageAutoResizeLimit

setStorageAutoResizeLimit

getTier

setTier

getUserLabels

setUserLabels

set

clone