Class Settings (0.1.0) 

public final class Settings extends GeneratedMessage implements SettingsOrBuilder

Database instance settings.

Protobuf type google.cloud.sql.v1.Settings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Settings

Implements

SettingsOrBuilder

Static Fields

ACCELERATED_REPLICA_MODE_FIELD_NUMBER

public static final int ACCELERATED_REPLICA_MODE_FIELD_NUMBER
Field Value
Type Description
int

ACTIVATION_POLICY_FIELD_NUMBER

public static final int ACTIVATION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

ACTIVE_DIRECTORY_CONFIG_FIELD_NUMBER

public static final int ACTIVE_DIRECTORY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ADVANCED_MACHINE_FEATURES_FIELD_NUMBER

public static final int ADVANCED_MACHINE_FEATURES_FIELD_NUMBER
Field Value
Type Description
int

AUTHORIZED_GAE_APPLICATIONS_FIELD_NUMBER

public static final int AUTHORIZED_GAE_APPLICATIONS_FIELD_NUMBER
Field Value
Type Description
int

AUTO_UPGRADE_ENABLED_FIELD_NUMBER

public static final int AUTO_UPGRADE_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

AVAILABILITY_TYPE_FIELD_NUMBER

public static final int AVAILABILITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_CONFIGURATION_FIELD_NUMBER

public static final int BACKUP_CONFIGURATION_FIELD_NUMBER
Field Value
Type Description
int

COLLATION_FIELD_NUMBER

public static final int COLLATION_FIELD_NUMBER
Field Value
Type Description
int

CONNECTION_POOL_CONFIG_FIELD_NUMBER

public static final int CONNECTION_POOL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CONNECTOR_ENFORCEMENT_FIELD_NUMBER

public static final int CONNECTOR_ENFORCEMENT_FIELD_NUMBER
Field Value
Type Description
int

CRASH_SAFE_REPLICATION_ENABLED_FIELD_NUMBER

public static final int CRASH_SAFE_REPLICATION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FLAGS_FIELD_NUMBER

public static final int DATABASE_FLAGS_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_REPLICATION_ENABLED_FIELD_NUMBER

public static final int DATABASE_REPLICATION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

DATA_API_ACCESS_FIELD_NUMBER

public static final int DATA_API_ACCESS_FIELD_NUMBER
Field Value
Type Description
int

DATA_CACHE_CONFIG_FIELD_NUMBER

public static final int DATA_CACHE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DATA_DISK_PROVISIONED_IOPS_FIELD_NUMBER

public static final int DATA_DISK_PROVISIONED_IOPS_FIELD_NUMBER
Field Value
Type Description
int

DATA_DISK_PROVISIONED_THROUGHPUT_FIELD_NUMBER

public static final int DATA_DISK_PROVISIONED_THROUGHPUT_FIELD_NUMBER
Field Value
Type Description
int

DATA_DISK_SIZE_GB_FIELD_NUMBER

public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

DATA_DISK_TYPE_FIELD_NUMBER

public static final int DATA_DISK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DELETION_PROTECTION_ENABLED_FIELD_NUMBER

public static final int DELETION_PROTECTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

DENY_MAINTENANCE_PERIODS_FIELD_NUMBER

public static final int DENY_MAINTENANCE_PERIODS_FIELD_NUMBER
Field Value
Type Description
int

EDITION_FIELD_NUMBER

public static final int EDITION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_DATAPLEX_INTEGRATION_FIELD_NUMBER

public static final int ENABLE_DATAPLEX_INTEGRATION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_GOOGLE_ML_INTEGRATION_FIELD_NUMBER

public static final int ENABLE_GOOGLE_ML_INTEGRATION_FIELD_NUMBER
Field Value
Type Description
int

ENTRAID_CONFIG_FIELD_NUMBER

public static final int ENTRAID_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

FINAL_BACKUP_CONFIG_FIELD_NUMBER

public static final int FINAL_BACKUP_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INSIGHTS_CONFIG_FIELD_NUMBER

public static final int INSIGHTS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

IP_CONFIGURATION_FIELD_NUMBER

public static final int IP_CONFIGURATION_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_PREFERENCE_FIELD_NUMBER

public static final int LOCATION_PREFERENCE_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_WINDOW_FIELD_NUMBER

public static final int MAINTENANCE_WINDOW_FIELD_NUMBER
Field Value
Type Description
int

PASSWORD_VALIDATION_POLICY_FIELD_NUMBER

public static final int PASSWORD_VALIDATION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

PERFORMANCE_CAPTURE_CONFIG_FIELD_NUMBER

public static final int PERFORMANCE_CAPTURE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PRICING_PLAN_FIELD_NUMBER

public static final int PRICING_PLAN_FIELD_NUMBER
Field Value
Type Description
int

READ_POOL_AUTO_SCALE_CONFIG_FIELD_NUMBER

public static final int READ_POOL_AUTO_SCALE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

REPLICATION_LAG_MAX_SECONDS_FIELD_NUMBER

public static final int REPLICATION_LAG_MAX_SECONDS_FIELD_NUMBER
Field Value
Type Description
int

REPLICATION_TYPE_FIELD_NUMBER

public static final int REPLICATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

RETAIN_BACKUPS_ON_DELETE_FIELD_NUMBER

public static final int RETAIN_BACKUPS_ON_DELETE_FIELD_NUMBER
Field Value
Type Description
int

SETTINGS_VERSION_FIELD_NUMBER

public static final int SETTINGS_VERSION_FIELD_NUMBER
Field Value
Type Description
int

SQL_SERVER_AUDIT_CONFIG_FIELD_NUMBER

public static final int SQL_SERVER_AUDIT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_AUTO_RESIZE_FIELD_NUMBER

public static final int STORAGE_AUTO_RESIZE_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_AUTO_RESIZE_LIMIT_FIELD_NUMBER

public static final int STORAGE_AUTO_RESIZE_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Settings getDefaultInstance()
Returns
Type Description
Settings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Settings.Builder newBuilder()
Returns
Type Description
Settings.Builder

newBuilder(Settings prototype)

public static Settings.Builder newBuilder(Settings prototype)
Parameter
Name Description
prototype Settings
Returns
Type Description
Settings.Builder

parseDelimitedFrom(InputStream input)

public static Settings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Settings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Settings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Settings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Settings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Settings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Settings> parser()
Returns
Type Description
Parser<Settings>

Methods

containsUserLabels(String key)

public boolean containsUserLabels(String key)

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

map<string, string> user_labels = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAcceleratedReplicaMode()

public BoolValue getAcceleratedReplicaMode()

Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

.google.protobuf.BoolValue accelerated_replica_mode = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValue

The acceleratedReplicaMode.

getAcceleratedReplicaModeOrBuilder()

public BoolValueOrBuilder getAcceleratedReplicaModeOrBuilder()

Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

.google.protobuf.BoolValue accelerated_replica_mode = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValueOrBuilder

getActivationPolicy()

public Settings.SqlActivationPolicy 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.

.google.cloud.sql.v1.Settings.SqlActivationPolicy activation_policy = 10;

Returns
Type Description
Settings.SqlActivationPolicy

The activationPolicy.

getActivationPolicyValue()

public int getActivationPolicyValue()

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.

.google.cloud.sql.v1.Settings.SqlActivationPolicy activation_policy = 10;

Returns
Type Description
int

The enum numeric value on the wire for activationPolicy.

getActiveDirectoryConfig()

public SqlActiveDirectoryConfig getActiveDirectoryConfig()

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

.google.cloud.sql.v1.SqlActiveDirectoryConfig active_directory_config = 22;

Returns
Type Description
SqlActiveDirectoryConfig

The activeDirectoryConfig.

getActiveDirectoryConfigOrBuilder()

public SqlActiveDirectoryConfigOrBuilder getActiveDirectoryConfigOrBuilder()

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

.google.cloud.sql.v1.SqlActiveDirectoryConfig active_directory_config = 22;

Returns
Type Description
SqlActiveDirectoryConfigOrBuilder

getAdvancedMachineFeatures()

public AdvancedMachineFeatures getAdvancedMachineFeatures()

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

.google.cloud.sql.v1.AdvancedMachineFeatures advanced_machine_features = 35;

Returns
Type Description
AdvancedMachineFeatures

The advancedMachineFeatures.

getAdvancedMachineFeaturesOrBuilder()

public AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

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

.google.cloud.sql.v1.AdvancedMachineFeatures advanced_machine_features = 35;

Returns
Type Description
AdvancedMachineFeaturesOrBuilder

getAuthorizedGaeApplications(int index) (deprecated)

public String getAuthorizedGaeApplications(int index)

Deprecated. google.cloud.sql.v1.Settings.authorized_gae_applications is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1658

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

repeated string authorized_gae_applications = 2 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The authorizedGaeApplications at the given index.

getAuthorizedGaeApplicationsBytes(int index) (deprecated)

public ByteString getAuthorizedGaeApplicationsBytes(int index)

Deprecated. google.cloud.sql.v1.Settings.authorized_gae_applications is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1658

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

repeated string authorized_gae_applications = 2 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the authorizedGaeApplications at the given index.

getAuthorizedGaeApplicationsCount() (deprecated)

public int getAuthorizedGaeApplicationsCount()

Deprecated. google.cloud.sql.v1.Settings.authorized_gae_applications is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1658

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

repeated string authorized_gae_applications = 2 [deprecated = true];

Returns
Type Description
int

The count of authorizedGaeApplications.

getAuthorizedGaeApplicationsList() (deprecated)

public ProtocolStringList getAuthorizedGaeApplicationsList()

Deprecated. google.cloud.sql.v1.Settings.authorized_gae_applications is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1658

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

repeated string authorized_gae_applications = 2 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the authorizedGaeApplications.

getAutoUpgradeEnabled()

public boolean getAutoUpgradeEnabled()

Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.

optional bool auto_upgrade_enabled = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The autoUpgradeEnabled.

getAvailabilityType()

public SqlAvailabilityType 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.

.google.cloud.sql.v1.SqlAvailabilityType availability_type = 6;

Returns
Type Description
SqlAvailabilityType

The availabilityType.

getAvailabilityTypeValue()

public int getAvailabilityTypeValue()

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.

.google.cloud.sql.v1.SqlAvailabilityType availability_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for availabilityType.

getBackupConfiguration()

public BackupConfiguration getBackupConfiguration()

The daily backup configuration for the instance.

.google.cloud.sql.v1.BackupConfiguration backup_configuration = 17;

Returns
Type Description
BackupConfiguration

The backupConfiguration.

getBackupConfigurationOrBuilder()

public BackupConfigurationOrBuilder getBackupConfigurationOrBuilder()

The daily backup configuration for the instance.

.google.cloud.sql.v1.BackupConfiguration backup_configuration = 17;

Returns
Type Description
BackupConfigurationOrBuilder

getCollation()

public String getCollation()

The name of server Instance collation.

string collation = 23;

Returns
Type Description
String

The collation.

getCollationBytes()

public ByteString getCollationBytes()

The name of server Instance collation.

string collation = 23;

Returns
Type Description
ByteString

The bytes for collation.

getConnectionPoolConfig()

public ConnectionPoolConfig getConnectionPoolConfig()

Optional. The managed connection pooling configuration for the instance.

optional .google.cloud.sql.v1.ConnectionPoolConfig connection_pool_config = 45 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConnectionPoolConfig

The connectionPoolConfig.

getConnectionPoolConfigOrBuilder()

public ConnectionPoolConfigOrBuilder getConnectionPoolConfigOrBuilder()

Optional. The managed connection pooling configuration for the instance.

optional .google.cloud.sql.v1.ConnectionPoolConfig connection_pool_config = 45 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConnectionPoolConfigOrBuilder

getConnectorEnforcement()

public Settings.ConnectorEnforcement getConnectorEnforcement()

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.

.google.cloud.sql.v1.Settings.ConnectorEnforcement connector_enforcement = 32;

Returns
Type Description
Settings.ConnectorEnforcement

The connectorEnforcement.

getConnectorEnforcementValue()

public int getConnectorEnforcementValue()

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.

.google.cloud.sql.v1.Settings.ConnectorEnforcement connector_enforcement = 32;

Returns
Type Description
int

The enum numeric value on the wire for connectorEnforcement.

getCrashSafeReplicationEnabled() (deprecated)

public BoolValue getCrashSafeReplicationEnabled()

Deprecated. google.cloud.sql.v1.Settings.crash_safe_replication_enabled is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1739

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.

.google.protobuf.BoolValue crash_safe_replication_enabled = 19 [deprecated = true];

Returns
Type Description
BoolValue

The crashSafeReplicationEnabled.

getCrashSafeReplicationEnabledOrBuilder() (deprecated)

public BoolValueOrBuilder getCrashSafeReplicationEnabledOrBuilder()

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.

.google.protobuf.BoolValue crash_safe_replication_enabled = 19 [deprecated = true];

Returns
Type Description
BoolValueOrBuilder

getDataApiAccess()

public Settings.DataApiAccess getDataApiAccess()

This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.

optional .google.cloud.sql.v1.Settings.DataApiAccess data_api_access = 53;

Returns
Type Description
Settings.DataApiAccess

The dataApiAccess.

getDataApiAccessValue()

public int getDataApiAccessValue()

This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.

optional .google.cloud.sql.v1.Settings.DataApiAccess data_api_access = 53;

Returns
Type Description
int

The enum numeric value on the wire for dataApiAccess.

getDataCacheConfig()

public DataCacheConfig getDataCacheConfig()

Configuration for data cache.

.google.cloud.sql.v1.DataCacheConfig data_cache_config = 37;

Returns
Type Description
DataCacheConfig

The dataCacheConfig.

getDataCacheConfigOrBuilder()

public DataCacheConfigOrBuilder getDataCacheConfigOrBuilder()

Configuration for data cache.

.google.cloud.sql.v1.DataCacheConfig data_cache_config = 37;

Returns
Type Description
DataCacheConfigOrBuilder

getDataDiskProvisionedIops()

public long getDataDiskProvisionedIops()

Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.

optional int64 data_disk_provisioned_iops = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The dataDiskProvisionedIops.

getDataDiskProvisionedThroughput()

public long getDataDiskProvisionedThroughput()

Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.

optional int64 data_disk_provisioned_throughput = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The dataDiskProvisionedThroughput.

getDataDiskSizeGb()

public Int64Value getDataDiskSizeGb()

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

.google.protobuf.Int64Value data_disk_size_gb = 20;

Returns
Type Description
Int64Value

The dataDiskSizeGb.

getDataDiskSizeGbOrBuilder()

public Int64ValueOrBuilder getDataDiskSizeGbOrBuilder()

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

.google.protobuf.Int64Value data_disk_size_gb = 20;

Returns
Type Description
Int64ValueOrBuilder

getDataDiskType()

public SqlDataDiskType getDataDiskType()

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

.google.cloud.sql.v1.SqlDataDiskType data_disk_type = 15;

Returns
Type Description
SqlDataDiskType

The dataDiskType.

getDataDiskTypeValue()

public int getDataDiskTypeValue()

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

.google.cloud.sql.v1.SqlDataDiskType data_disk_type = 15;

Returns
Type Description
int

The enum numeric value on the wire for dataDiskType.

getDatabaseFlags(int index)

public DatabaseFlags getDatabaseFlags(int index)

The database flags passed to the instance at startup.

repeated .google.cloud.sql.v1.DatabaseFlags database_flags = 14;

Parameter
Name Description
index int
Returns
Type Description
DatabaseFlags

getDatabaseFlagsCount()

public int getDatabaseFlagsCount()

The database flags passed to the instance at startup.

repeated .google.cloud.sql.v1.DatabaseFlags database_flags = 14;

Returns
Type Description
int

getDatabaseFlagsList()

public List<DatabaseFlags> getDatabaseFlagsList()

The database flags passed to the instance at startup.

repeated .google.cloud.sql.v1.DatabaseFlags database_flags = 14;

Returns
Type Description
List<DatabaseFlags>

getDatabaseFlagsOrBuilder(int index)

public DatabaseFlagsOrBuilder getDatabaseFlagsOrBuilder(int index)

The database flags passed to the instance at startup.

repeated .google.cloud.sql.v1.DatabaseFlags database_flags = 14;

Parameter
Name Description
index int
Returns
Type Description
DatabaseFlagsOrBuilder

getDatabaseFlagsOrBuilderList()

public List<? extends DatabaseFlagsOrBuilder> getDatabaseFlagsOrBuilderList()

The database flags passed to the instance at startup.

repeated .google.cloud.sql.v1.DatabaseFlags database_flags = 14;

Returns
Type Description
List<? extends com.google.cloud.sql.v1.DatabaseFlagsOrBuilder>

getDatabaseReplicationEnabled()

public BoolValue getDatabaseReplicationEnabled()

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

.google.protobuf.BoolValue database_replication_enabled = 18;

Returns
Type Description
BoolValue

The databaseReplicationEnabled.

getDatabaseReplicationEnabledOrBuilder()

public BoolValueOrBuilder getDatabaseReplicationEnabledOrBuilder()

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

.google.protobuf.BoolValue database_replication_enabled = 18;

Returns
Type Description
BoolValueOrBuilder

getDefaultInstanceForType()

public Settings getDefaultInstanceForType()
Returns
Type Description
Settings

getDeletionProtectionEnabled()

public BoolValue getDeletionProtectionEnabled()

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Returns
Type Description
BoolValue

The deletionProtectionEnabled.

getDeletionProtectionEnabledOrBuilder()

public BoolValueOrBuilder getDeletionProtectionEnabledOrBuilder()

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Returns
Type Description
BoolValueOrBuilder

getDenyMaintenancePeriods(int index)

public DenyMaintenancePeriod getDenyMaintenancePeriods(int index)

Deny maintenance periods

repeated .google.cloud.sql.v1.DenyMaintenancePeriod deny_maintenance_periods = 24;

Parameter
Name Description
index int
Returns
Type Description
DenyMaintenancePeriod

getDenyMaintenancePeriodsCount()

public int getDenyMaintenancePeriodsCount()

Deny maintenance periods

repeated .google.cloud.sql.v1.DenyMaintenancePeriod deny_maintenance_periods = 24;

Returns
Type Description
int

getDenyMaintenancePeriodsList()

public List<DenyMaintenancePeriod> getDenyMaintenancePeriodsList()

Deny maintenance periods

repeated .google.cloud.sql.v1.DenyMaintenancePeriod deny_maintenance_periods = 24;

Returns
Type Description
List<DenyMaintenancePeriod>

getDenyMaintenancePeriodsOrBuilder(int index)

public DenyMaintenancePeriodOrBuilder getDenyMaintenancePeriodsOrBuilder(int index)

Deny maintenance periods

repeated .google.cloud.sql.v1.DenyMaintenancePeriod deny_maintenance_periods = 24;

Parameter
Name Description
index int
Returns
Type Description
DenyMaintenancePeriodOrBuilder

getDenyMaintenancePeriodsOrBuilderList()

public List<? extends DenyMaintenancePeriodOrBuilder> getDenyMaintenancePeriodsOrBuilderList()

Deny maintenance periods

repeated .google.cloud.sql.v1.DenyMaintenancePeriod deny_maintenance_periods = 24;

Returns
Type Description
List<? extends com.google.cloud.sql.v1.DenyMaintenancePeriodOrBuilder>

getEdition()

public Settings.Edition getEdition()

Optional. The edition type of the Cloud SQL instance.

.google.cloud.sql.v1.Settings.Edition edition = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Settings.Edition

The edition.

getEditionValue()

public int getEditionValue()

Optional. The edition type of the Cloud SQL instance.

.google.cloud.sql.v1.Settings.Edition edition = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for edition.

getEnableDataplexIntegration()

public BoolValue getEnableDataplexIntegration()

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.

.google.protobuf.BoolValue enable_dataplex_integration = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValue

The enableDataplexIntegration.

getEnableDataplexIntegrationOrBuilder()

public BoolValueOrBuilder getEnableDataplexIntegrationOrBuilder()

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.

.google.protobuf.BoolValue enable_dataplex_integration = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValueOrBuilder

getEnableGoogleMlIntegration()

public BoolValue getEnableGoogleMlIntegration()

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 MySQL and Cloud SQL for PostgreSQL instances.

.google.protobuf.BoolValue enable_google_ml_integration = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValue

The enableGoogleMlIntegration.

getEnableGoogleMlIntegrationOrBuilder()

public BoolValueOrBuilder getEnableGoogleMlIntegrationOrBuilder()

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 MySQL and Cloud SQL for PostgreSQL instances.

.google.protobuf.BoolValue enable_google_ml_integration = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValueOrBuilder

getEntraidConfig()

public SqlServerEntraIdConfig getEntraidConfig()

Optional. The Microsoft Entra ID configuration for the SQL Server instance.

.google.cloud.sql.v1.SqlServerEntraIdConfig entraid_config = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlServerEntraIdConfig

The entraidConfig.

getEntraidConfigOrBuilder()

public SqlServerEntraIdConfigOrBuilder getEntraidConfigOrBuilder()

Optional. The Microsoft Entra ID configuration for the SQL Server instance.

.google.cloud.sql.v1.SqlServerEntraIdConfig entraid_config = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlServerEntraIdConfigOrBuilder

getFinalBackupConfig()

public FinalBackupConfig getFinalBackupConfig()

Optional. The final backup configuration for the instance.

optional .google.cloud.sql.v1.FinalBackupConfig final_backup_config = 47 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FinalBackupConfig

The finalBackupConfig.

getFinalBackupConfigOrBuilder()

public FinalBackupConfigOrBuilder getFinalBackupConfigOrBuilder()

Optional. The final backup configuration for the instance.

optional .google.cloud.sql.v1.FinalBackupConfig final_backup_config = 47 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FinalBackupConfigOrBuilder

getInsightsConfig()

public InsightsConfig getInsightsConfig()

Insights configuration, for now relevant only for Postgres.

.google.cloud.sql.v1.InsightsConfig insights_config = 25;

Returns
Type Description
InsightsConfig

The insightsConfig.

getInsightsConfigOrBuilder()

public InsightsConfigOrBuilder getInsightsConfigOrBuilder()

Insights configuration, for now relevant only for Postgres.

.google.cloud.sql.v1.InsightsConfig insights_config = 25;

Returns
Type Description
InsightsConfigOrBuilder

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.

.google.cloud.sql.v1.IpConfiguration ip_configuration = 11;

Returns
Type Description
IpConfiguration

The ipConfiguration.

getIpConfigurationOrBuilder()

public IpConfigurationOrBuilder getIpConfigurationOrBuilder()

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.

.google.cloud.sql.v1.IpConfiguration ip_configuration = 11;

Returns
Type Description
IpConfigurationOrBuilder

getKind()

public String getKind()

This is always sql#settings.

string kind = 4;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#settings.

string kind = 4;

Returns
Type Description
ByteString

The bytes for kind.

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.

.google.cloud.sql.v1.LocationPreference location_preference = 13;

Returns
Type Description
LocationPreference

The locationPreference.

getLocationPreferenceOrBuilder()

public LocationPreferenceOrBuilder getLocationPreferenceOrBuilder()

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.

.google.cloud.sql.v1.LocationPreference location_preference = 13;

Returns
Type Description
LocationPreferenceOrBuilder

getMaintenanceWindow()

public MaintenanceWindow getMaintenanceWindow()

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

.google.cloud.sql.v1.MaintenanceWindow maintenance_window = 16;

Returns
Type Description
MaintenanceWindow

The maintenanceWindow.

getMaintenanceWindowOrBuilder()

public MaintenanceWindowOrBuilder getMaintenanceWindowOrBuilder()

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

.google.cloud.sql.v1.MaintenanceWindow maintenance_window = 16;

Returns
Type Description
MaintenanceWindowOrBuilder

getParserForType()

public Parser<Settings> getParserForType()
Returns
Type Description
Parser<Settings>
Overrides

getPasswordValidationPolicy()

public PasswordValidationPolicy getPasswordValidationPolicy()

The local user password validation policy of the instance.

.google.cloud.sql.v1.PasswordValidationPolicy password_validation_policy = 27;

Returns
Type Description
PasswordValidationPolicy

The passwordValidationPolicy.

getPasswordValidationPolicyOrBuilder()

public PasswordValidationPolicyOrBuilder getPasswordValidationPolicyOrBuilder()

The local user password validation policy of the instance.

.google.cloud.sql.v1.PasswordValidationPolicy password_validation_policy = 27;

Returns
Type Description
PasswordValidationPolicyOrBuilder

getPerformanceCaptureConfig()

public PerformanceCaptureConfig getPerformanceCaptureConfig()

Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.

.google.cloud.sql.v1.PerformanceCaptureConfig performance_capture_config = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PerformanceCaptureConfig

The performanceCaptureConfig.

getPerformanceCaptureConfigOrBuilder()

public PerformanceCaptureConfigOrBuilder getPerformanceCaptureConfigOrBuilder()

Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.

.google.cloud.sql.v1.PerformanceCaptureConfig performance_capture_config = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PerformanceCaptureConfigOrBuilder

getPricingPlan()

public SqlPricingPlan getPricingPlan()

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

.google.cloud.sql.v1.SqlPricingPlan pricing_plan = 7;

Returns
Type Description
SqlPricingPlan

The pricingPlan.

getPricingPlanValue()

public int getPricingPlanValue()

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

.google.cloud.sql.v1.SqlPricingPlan pricing_plan = 7;

Returns
Type Description
int

The enum numeric value on the wire for pricingPlan.

getReadPoolAutoScaleConfig()

public ReadPoolAutoScaleConfig getReadPoolAutoScaleConfig()

Optional. The read pool auto-scale configuration for the instance.

optional .google.cloud.sql.v1.ReadPoolAutoScaleConfig read_pool_auto_scale_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReadPoolAutoScaleConfig

The readPoolAutoScaleConfig.

getReadPoolAutoScaleConfigOrBuilder()

public ReadPoolAutoScaleConfigOrBuilder getReadPoolAutoScaleConfigOrBuilder()

Optional. The read pool auto-scale configuration for the instance.

optional .google.cloud.sql.v1.ReadPoolAutoScaleConfig read_pool_auto_scale_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReadPoolAutoScaleConfigOrBuilder

getReplicationLagMaxSeconds()

public Int32Value getReplicationLagMaxSeconds()

Optional. Configuration value for recreation of replica after certain replication lag

.google.protobuf.Int32Value replication_lag_max_seconds = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Int32Value

The replicationLagMaxSeconds.

getReplicationLagMaxSecondsOrBuilder()

public Int32ValueOrBuilder getReplicationLagMaxSecondsOrBuilder()

Optional. Configuration value for recreation of replica after certain replication lag

.google.protobuf.Int32Value replication_lag_max_seconds = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Int32ValueOrBuilder

getReplicationType() (deprecated)

public SqlReplicationType getReplicationType()

Deprecated. google.cloud.sql.v1.Settings.replication_type is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1688

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

.google.cloud.sql.v1.SqlReplicationType replication_type = 8 [deprecated = true];

Returns
Type Description
SqlReplicationType

The replicationType.

getReplicationTypeValue() (deprecated)

public int getReplicationTypeValue()

Deprecated. google.cloud.sql.v1.Settings.replication_type is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1688

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

.google.cloud.sql.v1.SqlReplicationType replication_type = 8 [deprecated = true];

Returns
Type Description
int

The enum numeric value on the wire for replicationType.

getRetainBackupsOnDelete()

public BoolValue getRetainBackupsOnDelete()

Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.

.google.protobuf.BoolValue retain_backups_on_delete = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValue

The retainBackupsOnDelete.

getRetainBackupsOnDeleteOrBuilder()

public BoolValueOrBuilder getRetainBackupsOnDeleteOrBuilder()

Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.

.google.protobuf.BoolValue retain_backups_on_delete = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSettingsVersion()

public Int64Value 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.

.google.protobuf.Int64Value settings_version = 1;

Returns
Type Description
Int64Value

The settingsVersion.

getSettingsVersionOrBuilder()

public Int64ValueOrBuilder getSettingsVersionOrBuilder()

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.

.google.protobuf.Int64Value settings_version = 1;

Returns
Type Description
Int64ValueOrBuilder

getSqlServerAuditConfig()

public SqlServerAuditConfig getSqlServerAuditConfig()

SQL Server specific audit configuration.

.google.cloud.sql.v1.SqlServerAuditConfig sql_server_audit_config = 29;

Returns
Type Description
SqlServerAuditConfig

The sqlServerAuditConfig.

getSqlServerAuditConfigOrBuilder()

public SqlServerAuditConfigOrBuilder getSqlServerAuditConfigOrBuilder()

SQL Server specific audit configuration.

.google.cloud.sql.v1.SqlServerAuditConfig sql_server_audit_config = 29;

Returns
Type Description
SqlServerAuditConfigOrBuilder

getStorageAutoResize()

public BoolValue getStorageAutoResize()

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Returns
Type Description
BoolValue

The storageAutoResize.

getStorageAutoResizeLimit()

public Int64Value getStorageAutoResizeLimit()

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

.google.protobuf.Int64Value storage_auto_resize_limit = 9;

Returns
Type Description
Int64Value

The storageAutoResizeLimit.

getStorageAutoResizeLimitOrBuilder()

public Int64ValueOrBuilder getStorageAutoResizeLimitOrBuilder()

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

.google.protobuf.Int64Value storage_auto_resize_limit = 9;

Returns
Type Description
Int64ValueOrBuilder

getStorageAutoResizeOrBuilder()

public BoolValueOrBuilder getStorageAutoResizeOrBuilder()

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Returns
Type Description
BoolValueOrBuilder

getTier()

public String getTier()

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

string tier = 3;

Returns
Type Description
String

The tier.

getTierBytes()

public ByteString getTierBytes()

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

string tier = 3;

Returns
Type Description
ByteString

The bytes for tier.

getTimeZone()

public String getTimeZone()

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

string time_zone = 34;

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

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

string time_zone = 34;

Returns
Type Description
ByteString

The bytes for timeZone.

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

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

map<string, string> user_labels = 5;

Returns
Type Description
int

getUserLabelsMap()

public Map<String,String> getUserLabelsMap()

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

map<string, string> user_labels = 5;

Returns
Type Description
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(String key, String defaultValue)

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

map<string, string> user_labels = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(String key)

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

map<string, string> user_labels = 5;

Parameter
Name Description
key String
Returns
Type Description
String

hasAcceleratedReplicaMode()

public boolean hasAcceleratedReplicaMode()

Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.

.google.protobuf.BoolValue accelerated_replica_mode = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the acceleratedReplicaMode field is set.

hasActiveDirectoryConfig()

public boolean hasActiveDirectoryConfig()

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

.google.cloud.sql.v1.SqlActiveDirectoryConfig active_directory_config = 22;

Returns
Type Description
boolean

Whether the activeDirectoryConfig field is set.

hasAdvancedMachineFeatures()

public boolean hasAdvancedMachineFeatures()

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

.google.cloud.sql.v1.AdvancedMachineFeatures advanced_machine_features = 35;

Returns
Type Description
boolean

Whether the advancedMachineFeatures field is set.

hasAutoUpgradeEnabled()

public boolean hasAutoUpgradeEnabled()

Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.

optional bool auto_upgrade_enabled = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the autoUpgradeEnabled field is set.

hasBackupConfiguration()

public boolean hasBackupConfiguration()

The daily backup configuration for the instance.

.google.cloud.sql.v1.BackupConfiguration backup_configuration = 17;

Returns
Type Description
boolean

Whether the backupConfiguration field is set.

hasConnectionPoolConfig()

public boolean hasConnectionPoolConfig()

Optional. The managed connection pooling configuration for the instance.

optional .google.cloud.sql.v1.ConnectionPoolConfig connection_pool_config = 45 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the connectionPoolConfig field is set.

hasCrashSafeReplicationEnabled() (deprecated)

public boolean hasCrashSafeReplicationEnabled()

Deprecated. google.cloud.sql.v1.Settings.crash_safe_replication_enabled is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=1739

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.

.google.protobuf.BoolValue crash_safe_replication_enabled = 19 [deprecated = true];

Returns
Type Description
boolean

Whether the crashSafeReplicationEnabled field is set.

hasDataApiAccess()

public boolean hasDataApiAccess()

This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.

optional .google.cloud.sql.v1.Settings.DataApiAccess data_api_access = 53;

Returns
Type Description
boolean

Whether the dataApiAccess field is set.

hasDataCacheConfig()

public boolean hasDataCacheConfig()

Configuration for data cache.

.google.cloud.sql.v1.DataCacheConfig data_cache_config = 37;

Returns
Type Description
boolean

Whether the dataCacheConfig field is set.

hasDataDiskProvisionedIops()

public boolean hasDataDiskProvisionedIops()

Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.

optional int64 data_disk_provisioned_iops = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataDiskProvisionedIops field is set.

hasDataDiskProvisionedThroughput()

public boolean hasDataDiskProvisionedThroughput()

Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.

optional int64 data_disk_provisioned_throughput = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataDiskProvisionedThroughput field is set.

hasDataDiskSizeGb()

public boolean hasDataDiskSizeGb()

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

.google.protobuf.Int64Value data_disk_size_gb = 20;

Returns
Type Description
boolean

Whether the dataDiskSizeGb field is set.

hasDatabaseReplicationEnabled()

public boolean hasDatabaseReplicationEnabled()

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

.google.protobuf.BoolValue database_replication_enabled = 18;

Returns
Type Description
boolean

Whether the databaseReplicationEnabled field is set.

hasDeletionProtectionEnabled()

public boolean hasDeletionProtectionEnabled()

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Returns
Type Description
boolean

Whether the deletionProtectionEnabled field is set.

hasEnableDataplexIntegration()

public boolean hasEnableDataplexIntegration()

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.

.google.protobuf.BoolValue enable_dataplex_integration = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the enableDataplexIntegration field is set.

hasEnableGoogleMlIntegration()

public boolean hasEnableGoogleMlIntegration()

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 MySQL and Cloud SQL for PostgreSQL instances.

.google.protobuf.BoolValue enable_google_ml_integration = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the enableGoogleMlIntegration field is set.

hasEntraidConfig()

public boolean hasEntraidConfig()

Optional. The Microsoft Entra ID configuration for the SQL Server instance.

.google.cloud.sql.v1.SqlServerEntraIdConfig entraid_config = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the entraidConfig field is set.

hasFinalBackupConfig()

public boolean hasFinalBackupConfig()

Optional. The final backup configuration for the instance.

optional .google.cloud.sql.v1.FinalBackupConfig final_backup_config = 47 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the finalBackupConfig field is set.

hasInsightsConfig()

public boolean hasInsightsConfig()

Insights configuration, for now relevant only for Postgres.

.google.cloud.sql.v1.InsightsConfig insights_config = 25;

Returns
Type Description
boolean

Whether the insightsConfig field is set.

hasIpConfiguration()

public boolean hasIpConfiguration()

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.

.google.cloud.sql.v1.IpConfiguration ip_configuration = 11;

Returns
Type Description
boolean

Whether the ipConfiguration field is set.

hasLocationPreference()

public boolean hasLocationPreference()

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.

.google.cloud.sql.v1.LocationPreference location_preference = 13;

Returns
Type Description
boolean

Whether the locationPreference field is set.

hasMaintenanceWindow()

public boolean hasMaintenanceWindow()

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

.google.cloud.sql.v1.MaintenanceWindow maintenance_window = 16;

Returns
Type Description
boolean

Whether the maintenanceWindow field is set.

hasPasswordValidationPolicy()

public boolean hasPasswordValidationPolicy()

The local user password validation policy of the instance.

.google.cloud.sql.v1.PasswordValidationPolicy password_validation_policy = 27;

Returns
Type Description
boolean

Whether the passwordValidationPolicy field is set.

hasPerformanceCaptureConfig()

public boolean hasPerformanceCaptureConfig()

Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.

.google.cloud.sql.v1.PerformanceCaptureConfig performance_capture_config = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the performanceCaptureConfig field is set.

hasReadPoolAutoScaleConfig()

public boolean hasReadPoolAutoScaleConfig()

Optional. The read pool auto-scale configuration for the instance.

optional .google.cloud.sql.v1.ReadPoolAutoScaleConfig read_pool_auto_scale_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the readPoolAutoScaleConfig field is set.

hasReplicationLagMaxSeconds()

public boolean hasReplicationLagMaxSeconds()

Optional. Configuration value for recreation of replica after certain replication lag

.google.protobuf.Int32Value replication_lag_max_seconds = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the replicationLagMaxSeconds field is set.

hasRetainBackupsOnDelete()

public boolean hasRetainBackupsOnDelete()

Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.

.google.protobuf.BoolValue retain_backups_on_delete = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the retainBackupsOnDelete field is set.

hasSettingsVersion()

public boolean hasSettingsVersion()

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.

.google.protobuf.Int64Value settings_version = 1;

Returns
Type Description
boolean

Whether the settingsVersion field is set.

hasSqlServerAuditConfig()

public boolean hasSqlServerAuditConfig()

SQL Server specific audit configuration.

.google.cloud.sql.v1.SqlServerAuditConfig sql_server_audit_config = 29;

Returns
Type Description
boolean

Whether the sqlServerAuditConfig field is set.

hasStorageAutoResize()

public boolean hasStorageAutoResize()

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Returns
Type Description
boolean

Whether the storageAutoResize field is set.

hasStorageAutoResizeLimit()

public boolean hasStorageAutoResizeLimit()

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

.google.protobuf.Int64Value storage_auto_resize_limit = 9;

Returns
Type Description
boolean

Whether the storageAutoResizeLimit field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Settings.Builder newBuilderForType()
Returns
Type Description
Settings.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Settings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Settings.Builder
Overrides

toBuilder()

public Settings.Builder toBuilder()
Returns
Type Description
Settings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException