Class Settings.Builder (0.1.0)

public static final class Settings.Builder extends GeneratedMessage.Builder<Settings.Builder> implements SettingsOrBuilder

Database instance settings.

Protobuf type google.cloud.sql.v1.Settings

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Settings.Builder

Implements

SettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllAuthorizedGaeApplications(Iterable<String> values) (deprecated)

public Settings.Builder addAllAuthorizedGaeApplications(Iterable<String> values)

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
`values`	`Iterable<String>` The authorizedGaeApplications to add.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

addAllDatabaseFlags(Iterable<? extends DatabaseFlags> values)

public Settings.Builder addAllDatabaseFlags(Iterable<? extends DatabaseFlags> values)

The database flags passed to the instance at startup.

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

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.sql.v1.DatabaseFlags>`

Returns
Type	Description
`Settings.Builder`

addAllDenyMaintenancePeriods(Iterable<? extends DenyMaintenancePeriod> values)

public Settings.Builder addAllDenyMaintenancePeriods(Iterable<? extends DenyMaintenancePeriod> values)

Deny maintenance periods

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

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.sql.v1.DenyMaintenancePeriod>`

Returns
Type	Description
`Settings.Builder`

addAuthorizedGaeApplications(String value) (deprecated)

public Settings.Builder addAuthorizedGaeApplications(String value)

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
`value`	`String` The authorizedGaeApplications to add.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

addAuthorizedGaeApplicationsBytes(ByteString value) (deprecated)

public Settings.Builder addAuthorizedGaeApplicationsBytes(ByteString value)

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
`value`	`ByteString` The bytes of the authorizedGaeApplications to add.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

addDatabaseFlags(DatabaseFlags value)

public Settings.Builder addDatabaseFlags(DatabaseFlags value)

The database flags passed to the instance at startup.

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

Parameter
Name	Description
`value`	`DatabaseFlags`

Returns
Type	Description
`Settings.Builder`

addDatabaseFlags(DatabaseFlags.Builder builderForValue)

public Settings.Builder addDatabaseFlags(DatabaseFlags.Builder builderForValue)

The database flags passed to the instance at startup.

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

Parameter
Name	Description
`builderForValue`	`DatabaseFlags.Builder`

Returns
Type	Description
`Settings.Builder`

addDatabaseFlags(int index, DatabaseFlags value)

public Settings.Builder addDatabaseFlags(int index, DatabaseFlags value)

The database flags passed to the instance at startup.

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

Parameters
Name	Description
`index`	`int`
`value`	`DatabaseFlags`

Returns
Type	Description
`Settings.Builder`

addDatabaseFlags(int index, DatabaseFlags.Builder builderForValue)

public Settings.Builder addDatabaseFlags(int index, DatabaseFlags.Builder builderForValue)

The database flags passed to the instance at startup.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DatabaseFlags.Builder`

Returns
Type	Description
`Settings.Builder`

addDatabaseFlagsBuilder()

public DatabaseFlags.Builder addDatabaseFlagsBuilder()

The database flags passed to the instance at startup.

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

Returns
Type	Description
`DatabaseFlags.Builder`

addDatabaseFlagsBuilder(int index)

public DatabaseFlags.Builder addDatabaseFlagsBuilder(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.Builder`

addDenyMaintenancePeriods(DenyMaintenancePeriod value)

public Settings.Builder addDenyMaintenancePeriods(DenyMaintenancePeriod value)

Deny maintenance periods

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

Parameter
Name	Description
`value`	`DenyMaintenancePeriod`

Returns
Type	Description
`Settings.Builder`

addDenyMaintenancePeriods(DenyMaintenancePeriod.Builder builderForValue)

public Settings.Builder addDenyMaintenancePeriods(DenyMaintenancePeriod.Builder builderForValue)

Deny maintenance periods

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

Parameter
Name	Description
`builderForValue`	`DenyMaintenancePeriod.Builder`

Returns
Type	Description
`Settings.Builder`

addDenyMaintenancePeriods(int index, DenyMaintenancePeriod value)

public Settings.Builder addDenyMaintenancePeriods(int index, DenyMaintenancePeriod value)

Deny maintenance periods

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

Parameters
Name	Description
`index`	`int`
`value`	`DenyMaintenancePeriod`

Returns
Type	Description
`Settings.Builder`

addDenyMaintenancePeriods(int index, DenyMaintenancePeriod.Builder builderForValue)

public Settings.Builder addDenyMaintenancePeriods(int index, DenyMaintenancePeriod.Builder builderForValue)

Deny maintenance periods

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DenyMaintenancePeriod.Builder`

Returns
Type	Description
`Settings.Builder`

addDenyMaintenancePeriodsBuilder()

public DenyMaintenancePeriod.Builder addDenyMaintenancePeriodsBuilder()

Deny maintenance periods

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

Returns
Type	Description
`DenyMaintenancePeriod.Builder`

addDenyMaintenancePeriodsBuilder(int index)

public DenyMaintenancePeriod.Builder addDenyMaintenancePeriodsBuilder(int index)

Deny maintenance periods

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DenyMaintenancePeriod.Builder`

build()

public Settings build()

Returns
Type	Description
`Settings`

buildPartial()

public Settings buildPartial()

Returns
Type	Description
`Settings`

clear()

public Settings.Builder clear()

Returns
Type	Description
`Settings.Builder`

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAcceleratedReplicaMode()

public Settings.Builder clearAcceleratedReplicaMode()

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
`Settings.Builder`

clearActivationPolicy()

public Settings.Builder clearActivationPolicy()

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.Builder`	This builder for chaining.

clearActiveDirectoryConfig()

public Settings.Builder clearActiveDirectoryConfig()

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

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

Returns
Type	Description
`Settings.Builder`

clearAdvancedMachineFeatures()

public Settings.Builder clearAdvancedMachineFeatures()

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

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

Returns
Type	Description
`Settings.Builder`

clearAuthorizedGaeApplications() (deprecated)

public Settings.Builder clearAuthorizedGaeApplications()

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
`Settings.Builder`	This builder for chaining.

clearAutoUpgradeEnabled()

public Settings.Builder clearAutoUpgradeEnabled()

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
`Settings.Builder`	This builder for chaining.

clearAvailabilityType()

public Settings.Builder clearAvailabilityType()

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
`Settings.Builder`	This builder for chaining.

clearBackupConfiguration()

public Settings.Builder clearBackupConfiguration()

The daily backup configuration for the instance.

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

Returns
Type	Description
`Settings.Builder`

clearCollation()

public Settings.Builder clearCollation()

The name of server Instance collation.

string collation = 23;

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

clearConnectionPoolConfig()

public Settings.Builder clearConnectionPoolConfig()

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
`Settings.Builder`

clearConnectorEnforcement()

public Settings.Builder clearConnectorEnforcement()

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.Builder`	This builder for chaining.

clearCrashSafeReplicationEnabled() (deprecated)

public Settings.Builder clearCrashSafeReplicationEnabled()

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
`Settings.Builder`

clearDataApiAccess()

public Settings.Builder clearDataApiAccess()

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.Builder`	This builder for chaining.

clearDataCacheConfig()

public Settings.Builder clearDataCacheConfig()

Configuration for data cache.

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

Returns
Type	Description
`Settings.Builder`

clearDataDiskProvisionedIops()

public Settings.Builder clearDataDiskProvisionedIops()

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
`Settings.Builder`	This builder for chaining.

clearDataDiskProvisionedThroughput()

public Settings.Builder clearDataDiskProvisionedThroughput()

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
`Settings.Builder`	This builder for chaining.

clearDataDiskSizeGb()

public Settings.Builder clearDataDiskSizeGb()

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
`Settings.Builder`

clearDataDiskType()

public Settings.Builder clearDataDiskType()

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
`Settings.Builder`	This builder for chaining.

clearDatabaseFlags()

public Settings.Builder clearDatabaseFlags()

The database flags passed to the instance at startup.

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

Returns
Type	Description
`Settings.Builder`

clearDatabaseReplicationEnabled()

public Settings.Builder clearDatabaseReplicationEnabled()

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
`Settings.Builder`

clearDeletionProtectionEnabled()

public Settings.Builder clearDeletionProtectionEnabled()

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Returns
Type	Description
`Settings.Builder`

clearDenyMaintenancePeriods()

public Settings.Builder clearDenyMaintenancePeriods()

Deny maintenance periods

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

Returns
Type	Description
`Settings.Builder`

clearEdition()

public Settings.Builder clearEdition()

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.Builder`	This builder for chaining.

clearEnableDataplexIntegration()

public Settings.Builder clearEnableDataplexIntegration()

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
`Settings.Builder`

clearEnableGoogleMlIntegration()

public Settings.Builder clearEnableGoogleMlIntegration()

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
`Settings.Builder`

clearEntraidConfig()

public Settings.Builder clearEntraidConfig()

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
`Settings.Builder`

clearFinalBackupConfig()

public Settings.Builder clearFinalBackupConfig()

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
`Settings.Builder`

clearInsightsConfig()

public Settings.Builder clearInsightsConfig()

Insights configuration, for now relevant only for Postgres.

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

Returns
Type	Description
`Settings.Builder`

clearIpConfiguration()

public Settings.Builder clearIpConfiguration()

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
`Settings.Builder`

clearKind()

public Settings.Builder clearKind()

This is always sql#settings.

string kind = 4;

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

clearLocationPreference()

public Settings.Builder clearLocationPreference()

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
`Settings.Builder`

clearMaintenanceWindow()

public Settings.Builder clearMaintenanceWindow()

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
`Settings.Builder`

clearPasswordValidationPolicy()

public Settings.Builder clearPasswordValidationPolicy()

The local user password validation policy of the instance.

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

Returns
Type	Description
`Settings.Builder`

clearPerformanceCaptureConfig()

public Settings.Builder clearPerformanceCaptureConfig()

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
`Settings.Builder`

clearPricingPlan()

public Settings.Builder clearPricingPlan()

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
`Settings.Builder`	This builder for chaining.

clearReadPoolAutoScaleConfig()

public Settings.Builder clearReadPoolAutoScaleConfig()

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
`Settings.Builder`

clearReplicationLagMaxSeconds()

public Settings.Builder clearReplicationLagMaxSeconds()

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
`Settings.Builder`

clearReplicationType() (deprecated)

public Settings.Builder clearReplicationType()

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
`Settings.Builder`	This builder for chaining.

clearRetainBackupsOnDelete()

public Settings.Builder clearRetainBackupsOnDelete()

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
`Settings.Builder`

clearSettingsVersion()

public Settings.Builder clearSettingsVersion()

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
`Settings.Builder`

clearSqlServerAuditConfig()

public Settings.Builder clearSqlServerAuditConfig()

SQL Server specific audit configuration.

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

Returns
Type	Description
`Settings.Builder`

clearStorageAutoResize()

public Settings.Builder clearStorageAutoResize()

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Returns
Type	Description
`Settings.Builder`

clearStorageAutoResizeLimit()

public Settings.Builder clearStorageAutoResizeLimit()

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
`Settings.Builder`

clearTier()

public Settings.Builder clearTier()

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
`Settings.Builder`	This builder for chaining.

clearTimeZone()

public Settings.Builder clearTimeZone()

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

string time_zone = 34;

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

clearUserLabels()

public Settings.Builder clearUserLabels()

Returns
Type	Description
`Settings.Builder`

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`

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.

getAcceleratedReplicaModeBuilder()

public BoolValue.Builder getAcceleratedReplicaModeBuilder()

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
`Builder`

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.

getActiveDirectoryConfigBuilder()

public SqlActiveDirectoryConfig.Builder getActiveDirectoryConfigBuilder()

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

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

Returns
Type	Description
`SqlActiveDirectoryConfig.Builder`

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.

getAdvancedMachineFeaturesBuilder()

public AdvancedMachineFeatures.Builder getAdvancedMachineFeaturesBuilder()

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.Builder`

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.

getBackupConfigurationBuilder()

public BackupConfiguration.Builder getBackupConfigurationBuilder()

The daily backup configuration for the instance.

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

Returns
Type	Description
`BackupConfiguration.Builder`

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.

getConnectionPoolConfigBuilder()

public ConnectionPoolConfig.Builder getConnectionPoolConfigBuilder()

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.Builder`

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

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

Returns
Type	Description
`Settings.ConnectorEnforcement`	The connectorEnforcement.

getConnectorEnforcementValue()

public int getConnectorEnforcementValue()

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

getCrashSafeReplicationEnabledBuilder() (deprecated)

public BoolValue.Builder getCrashSafeReplicationEnabledBuilder()

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
`Builder`

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.

getDataCacheConfigBuilder()

public DataCacheConfig.Builder getDataCacheConfigBuilder()

Configuration for data cache.

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

Returns
Type	Description
`DataCacheConfig.Builder`

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.

getDataDiskSizeGbBuilder()

public Int64Value.Builder getDataDiskSizeGbBuilder()

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
`Builder`

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`

getDatabaseFlagsBuilder(int index)

public DatabaseFlags.Builder getDatabaseFlagsBuilder(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.Builder`

getDatabaseFlagsBuilderList()

public List<DatabaseFlags.Builder> getDatabaseFlagsBuilderList()

The database flags passed to the instance at startup.

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

Returns
Type	Description
`List<Builder>`

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.

getDatabaseReplicationEnabledBuilder()

public BoolValue.Builder getDatabaseReplicationEnabledBuilder()

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
`Builder`

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.

getDeletionProtectionEnabledBuilder()

public BoolValue.Builder getDeletionProtectionEnabledBuilder()

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Returns
Type	Description
`Builder`

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`

getDenyMaintenancePeriodsBuilder(int index)

public DenyMaintenancePeriod.Builder getDenyMaintenancePeriodsBuilder(int index)

Deny maintenance periods

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DenyMaintenancePeriod.Builder`

getDenyMaintenancePeriodsBuilderList()

public List<DenyMaintenancePeriod.Builder> getDenyMaintenancePeriodsBuilderList()

Deny maintenance periods

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

Returns
Type	Description
`List<Builder>`

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

getEnableDataplexIntegrationBuilder()

public BoolValue.Builder getEnableDataplexIntegrationBuilder()

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
`Builder`

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

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

Returns
Type	Description
`BoolValue`	The enableGoogleMlIntegration.

getEnableGoogleMlIntegrationBuilder()

public BoolValue.Builder getEnableGoogleMlIntegrationBuilder()

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

Returns
Type	Description
`Builder`

getEnableGoogleMlIntegrationOrBuilder()

public BoolValueOrBuilder getEnableGoogleMlIntegrationOrBuilder()

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

getEntraidConfigBuilder()

public SqlServerEntraIdConfig.Builder getEntraidConfigBuilder()

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.Builder`

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.

getFinalBackupConfigBuilder()

public FinalBackupConfig.Builder getFinalBackupConfigBuilder()

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.Builder`

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.

getInsightsConfigBuilder()

public InsightsConfig.Builder getInsightsConfigBuilder()

Insights configuration, for now relevant only for Postgres.

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

Returns
Type	Description
`InsightsConfig.Builder`

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

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

Returns
Type	Description
`IpConfiguration`	The ipConfiguration.

getIpConfigurationBuilder()

public IpConfiguration.Builder getIpConfigurationBuilder()

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

Returns
Type	Description
`IpConfiguration.Builder`

getIpConfigurationOrBuilder()

public IpConfigurationOrBuilder getIpConfigurationOrBuilder()

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

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

Returns
Type	Description
`LocationPreference`	The locationPreference.

getLocationPreferenceBuilder()

public LocationPreference.Builder getLocationPreferenceBuilder()

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

Returns
Type	Description
`LocationPreference.Builder`

getLocationPreferenceOrBuilder()

public LocationPreferenceOrBuilder getLocationPreferenceOrBuilder()

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

getMaintenanceWindowBuilder()

public MaintenanceWindow.Builder getMaintenanceWindowBuilder()

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.Builder`

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`

getMutableUserLabels() (deprecated)

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

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.

getPasswordValidationPolicyBuilder()

public PasswordValidationPolicy.Builder getPasswordValidationPolicyBuilder()

The local user password validation policy of the instance.

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

Returns
Type	Description
`PasswordValidationPolicy.Builder`

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.

getPerformanceCaptureConfigBuilder()

public PerformanceCaptureConfig.Builder getPerformanceCaptureConfigBuilder()

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.Builder`

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.

getReadPoolAutoScaleConfigBuilder()

public ReadPoolAutoScaleConfig.Builder getReadPoolAutoScaleConfigBuilder()

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.Builder`

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.

getReplicationLagMaxSecondsBuilder()

public Int32Value.Builder getReplicationLagMaxSecondsBuilder()

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
`Builder`

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

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

Returns
Type	Description
`BoolValue`	The retainBackupsOnDelete.

getRetainBackupsOnDeleteBuilder()

public BoolValue.Builder getRetainBackupsOnDeleteBuilder()

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

Returns
Type	Description
`Builder`

getRetainBackupsOnDeleteOrBuilder()

public BoolValueOrBuilder getRetainBackupsOnDeleteOrBuilder()

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

Returns
Type	Description
`BoolValueOrBuilder`

getSettingsVersion()

public Int64Value getSettingsVersion()

.google.protobuf.Int64Value settings_version = 1;

Returns
Type	Description
`Int64Value`	The settingsVersion.

getSettingsVersionBuilder()

public Int64Value.Builder getSettingsVersionBuilder()

.google.protobuf.Int64Value settings_version = 1;

Returns
Type	Description
`Builder`

getSettingsVersionOrBuilder()

public Int64ValueOrBuilder getSettingsVersionOrBuilder()

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

getSqlServerAuditConfigBuilder()

public SqlServerAuditConfig.Builder getSqlServerAuditConfigBuilder()

SQL Server specific audit configuration.

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

Returns
Type	Description
`SqlServerAuditConfig.Builder`

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.

getStorageAutoResizeBuilder()

public BoolValue.Builder getStorageAutoResizeBuilder()

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Returns
Type	Description
`Builder`

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.

getStorageAutoResizeLimitBuilder()

public Int64Value.Builder getStorageAutoResizeLimitBuilder()

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
`Builder`

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

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

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

Returns
Type	Description
`boolean`	Whether the ipConfiguration field is set.

hasLocationPreference()

public boolean hasLocationPreference()

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeAcceleratedReplicaMode(BoolValue value)

public Settings.Builder mergeAcceleratedReplicaMode(BoolValue value)

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];

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeActiveDirectoryConfig(SqlActiveDirectoryConfig value)

public Settings.Builder mergeActiveDirectoryConfig(SqlActiveDirectoryConfig value)

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

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

Parameter
Name	Description
`value`	`SqlActiveDirectoryConfig`

Returns
Type	Description
`Settings.Builder`

mergeAdvancedMachineFeatures(AdvancedMachineFeatures value)

public Settings.Builder mergeAdvancedMachineFeatures(AdvancedMachineFeatures value)

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

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

Parameter
Name	Description
`value`	`AdvancedMachineFeatures`

Returns
Type	Description
`Settings.Builder`

mergeBackupConfiguration(BackupConfiguration value)

public Settings.Builder mergeBackupConfiguration(BackupConfiguration value)

The daily backup configuration for the instance.

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

Parameter
Name	Description
`value`	`BackupConfiguration`

Returns
Type	Description
`Settings.Builder`

mergeConnectionPoolConfig(ConnectionPoolConfig value)

public Settings.Builder mergeConnectionPoolConfig(ConnectionPoolConfig value)

Optional. The managed connection pooling configuration for the instance.

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

Parameter
Name	Description
`value`	`ConnectionPoolConfig`

Returns
Type	Description
`Settings.Builder`

mergeCrashSafeReplicationEnabled(BoolValue value) (deprecated)

public Settings.Builder mergeCrashSafeReplicationEnabled(BoolValue value)

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];

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeDataCacheConfig(DataCacheConfig value)

public Settings.Builder mergeDataCacheConfig(DataCacheConfig value)

Configuration for data cache.

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

Parameter
Name	Description
`value`	`DataCacheConfig`

Returns
Type	Description
`Settings.Builder`

mergeDataDiskSizeGb(Int64Value value)

public Settings.Builder mergeDataDiskSizeGb(Int64Value value)

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

.google.protobuf.Int64Value data_disk_size_gb = 20;

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`Settings.Builder`

mergeDatabaseReplicationEnabled(BoolValue value)

public Settings.Builder mergeDatabaseReplicationEnabled(BoolValue value)

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;

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeDeletionProtectionEnabled(BoolValue value)

public Settings.Builder mergeDeletionProtectionEnabled(BoolValue value)

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeEnableDataplexIntegration(BoolValue value)

public Settings.Builder mergeEnableDataplexIntegration(BoolValue value)

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];

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeEnableGoogleMlIntegration(BoolValue value)

public Settings.Builder mergeEnableGoogleMlIntegration(BoolValue value)

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

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeEntraidConfig(SqlServerEntraIdConfig value)

public Settings.Builder mergeEntraidConfig(SqlServerEntraIdConfig value)

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

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

Parameter
Name	Description
`value`	`SqlServerEntraIdConfig`

Returns
Type	Description
`Settings.Builder`

mergeFinalBackupConfig(FinalBackupConfig value)

public Settings.Builder mergeFinalBackupConfig(FinalBackupConfig value)

Optional. The final backup configuration for the instance.

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

Parameter
Name	Description
`value`	`FinalBackupConfig`

Returns
Type	Description
`Settings.Builder`

mergeFrom(Settings other)

public Settings.Builder mergeFrom(Settings other)

Parameter
Name	Description
`other`	`Settings`

Returns
Type	Description
`Settings.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Settings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Settings.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Settings.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Settings.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInsightsConfig(InsightsConfig value)

public Settings.Builder mergeInsightsConfig(InsightsConfig value)

Insights configuration, for now relevant only for Postgres.

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

Parameter
Name	Description
`value`	`InsightsConfig`

Returns
Type	Description
`Settings.Builder`

mergeIpConfiguration(IpConfiguration value)

public Settings.Builder mergeIpConfiguration(IpConfiguration value)

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

Parameter
Name	Description
`value`	`IpConfiguration`

Returns
Type	Description
`Settings.Builder`

mergeLocationPreference(LocationPreference value)

public Settings.Builder mergeLocationPreference(LocationPreference value)

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

Parameter
Name	Description
`value`	`LocationPreference`

Returns
Type	Description
`Settings.Builder`

mergeMaintenanceWindow(MaintenanceWindow value)

public Settings.Builder mergeMaintenanceWindow(MaintenanceWindow value)

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;

Parameter
Name	Description
`value`	`MaintenanceWindow`

Returns
Type	Description
`Settings.Builder`

mergePasswordValidationPolicy(PasswordValidationPolicy value)

public Settings.Builder mergePasswordValidationPolicy(PasswordValidationPolicy value)

The local user password validation policy of the instance.

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

Parameter
Name	Description
`value`	`PasswordValidationPolicy`

Returns
Type	Description
`Settings.Builder`

mergePerformanceCaptureConfig(PerformanceCaptureConfig value)

public Settings.Builder mergePerformanceCaptureConfig(PerformanceCaptureConfig value)

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];

Parameter
Name	Description
`value`	`PerformanceCaptureConfig`

Returns
Type	Description
`Settings.Builder`

mergeReadPoolAutoScaleConfig(ReadPoolAutoScaleConfig value)

public Settings.Builder mergeReadPoolAutoScaleConfig(ReadPoolAutoScaleConfig value)

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];

Parameter
Name	Description
`value`	`ReadPoolAutoScaleConfig`

Returns
Type	Description
`Settings.Builder`

mergeReplicationLagMaxSeconds(Int32Value value)

public Settings.Builder mergeReplicationLagMaxSeconds(Int32Value value)

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

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

Parameter
Name	Description
`value`	`Int32Value`

Returns
Type	Description
`Settings.Builder`

mergeRetainBackupsOnDelete(BoolValue value)

public Settings.Builder mergeRetainBackupsOnDelete(BoolValue value)

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

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeSettingsVersion(Int64Value value)

public Settings.Builder mergeSettingsVersion(Int64Value value)

.google.protobuf.Int64Value settings_version = 1;

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`Settings.Builder`

mergeSqlServerAuditConfig(SqlServerAuditConfig value)

public Settings.Builder mergeSqlServerAuditConfig(SqlServerAuditConfig value)

SQL Server specific audit configuration.

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

Parameter
Name	Description
`value`	`SqlServerAuditConfig`

Returns
Type	Description
`Settings.Builder`

mergeStorageAutoResize(BoolValue value)

public Settings.Builder mergeStorageAutoResize(BoolValue value)

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

mergeStorageAutoResizeLimit(Int64Value value)

public Settings.Builder mergeStorageAutoResizeLimit(Int64Value value)

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;

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`Settings.Builder`

putAllUserLabels(Map<String,String> values)

public Settings.Builder putAllUserLabels(Map<String,String> values)

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
`values`	`Map<String,String>`

Returns
Type	Description
`Settings.Builder`

putUserLabels(String key, String value)

public Settings.Builder putUserLabels(String key, String value)

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`
`value`	`String`

Returns
Type	Description
`Settings.Builder`

removeDatabaseFlags(int index)

public Settings.Builder removeDatabaseFlags(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
`Settings.Builder`

removeDenyMaintenancePeriods(int index)

public Settings.Builder removeDenyMaintenancePeriods(int index)

Deny maintenance periods

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Settings.Builder`

removeUserLabels(String key)

public Settings.Builder removeUserLabels(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
`Settings.Builder`

setAcceleratedReplicaMode(BoolValue value)

public Settings.Builder setAcceleratedReplicaMode(BoolValue value)

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];

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setAcceleratedReplicaMode(BoolValue.Builder builderForValue)

public Settings.Builder setAcceleratedReplicaMode(BoolValue.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setActivationPolicy(Settings.SqlActivationPolicy value)

public Settings.Builder setActivationPolicy(Settings.SqlActivationPolicy value)

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;

Parameter
Name	Description
`value`	`Settings.SqlActivationPolicy` The activationPolicy to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setActivationPolicyValue(int value)

public Settings.Builder setActivationPolicyValue(int value)

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;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for activationPolicy to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setActiveDirectoryConfig(SqlActiveDirectoryConfig value)

public Settings.Builder setActiveDirectoryConfig(SqlActiveDirectoryConfig value)

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

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

Parameter
Name	Description
`value`	`SqlActiveDirectoryConfig`

Returns
Type	Description
`Settings.Builder`

setActiveDirectoryConfig(SqlActiveDirectoryConfig.Builder builderForValue)

public Settings.Builder setActiveDirectoryConfig(SqlActiveDirectoryConfig.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`SqlActiveDirectoryConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setAdvancedMachineFeatures(AdvancedMachineFeatures value)

public Settings.Builder setAdvancedMachineFeatures(AdvancedMachineFeatures value)

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

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

Parameter
Name	Description
`value`	`AdvancedMachineFeatures`

Returns
Type	Description
`Settings.Builder`

setAdvancedMachineFeatures(AdvancedMachineFeatures.Builder builderForValue)

public Settings.Builder setAdvancedMachineFeatures(AdvancedMachineFeatures.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`AdvancedMachineFeatures.Builder`

Returns
Type	Description
`Settings.Builder`

setAuthorizedGaeApplications(int index, String value) (deprecated)

public Settings.Builder setAuthorizedGaeApplications(int index, String value)

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];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The authorizedGaeApplications to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setAutoUpgradeEnabled(boolean value)

public Settings.Builder setAutoUpgradeEnabled(boolean value)

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];

Parameter
Name	Description
`value`	`boolean` The autoUpgradeEnabled to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setAvailabilityType(SqlAvailabilityType value)

public Settings.Builder setAvailabilityType(SqlAvailabilityType value)

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;

Parameter
Name	Description
`value`	`SqlAvailabilityType` The availabilityType to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setAvailabilityTypeValue(int value)

public Settings.Builder setAvailabilityTypeValue(int value)

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;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for availabilityType to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setBackupConfiguration(BackupConfiguration value)

public Settings.Builder setBackupConfiguration(BackupConfiguration value)

The daily backup configuration for the instance.

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

Parameter
Name	Description
`value`	`BackupConfiguration`

Returns
Type	Description
`Settings.Builder`

setBackupConfiguration(BackupConfiguration.Builder builderForValue)

public Settings.Builder setBackupConfiguration(BackupConfiguration.Builder builderForValue)

The daily backup configuration for the instance.

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

Parameter
Name	Description
`builderForValue`	`BackupConfiguration.Builder`

Returns
Type	Description
`Settings.Builder`

setCollation(String value)

public Settings.Builder setCollation(String value)

The name of server Instance collation.

string collation = 23;

Parameter
Name	Description
`value`	`String` The collation to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setCollationBytes(ByteString value)

public Settings.Builder setCollationBytes(ByteString value)

The name of server Instance collation.

string collation = 23;

Parameter
Name	Description
`value`	`ByteString` The bytes for collation to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setConnectionPoolConfig(ConnectionPoolConfig value)

public Settings.Builder setConnectionPoolConfig(ConnectionPoolConfig value)

Optional. The managed connection pooling configuration for the instance.

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

Parameter
Name	Description
`value`	`ConnectionPoolConfig`

Returns
Type	Description
`Settings.Builder`

setConnectionPoolConfig(ConnectionPoolConfig.Builder builderForValue)

public Settings.Builder setConnectionPoolConfig(ConnectionPoolConfig.Builder builderForValue)

Optional. The managed connection pooling configuration for the instance.

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

Parameter
Name	Description
`builderForValue`	`ConnectionPoolConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setConnectorEnforcement(Settings.ConnectorEnforcement value)

public Settings.Builder setConnectorEnforcement(Settings.ConnectorEnforcement value)

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

Parameter
Name	Description
`value`	`Settings.ConnectorEnforcement` The connectorEnforcement to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setConnectorEnforcementValue(int value)

public Settings.Builder setConnectorEnforcementValue(int value)

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for connectorEnforcement to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setCrashSafeReplicationEnabled(BoolValue value) (deprecated)

public Settings.Builder setCrashSafeReplicationEnabled(BoolValue value)

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];

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setCrashSafeReplicationEnabled(BoolValue.Builder builderForValue) (deprecated)

public Settings.Builder setCrashSafeReplicationEnabled(BoolValue.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setDataApiAccess(Settings.DataApiAccess value)

public Settings.Builder setDataApiAccess(Settings.DataApiAccess value)

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;

Parameter
Name	Description
`value`	`Settings.DataApiAccess` The dataApiAccess to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setDataApiAccessValue(int value)

public Settings.Builder setDataApiAccessValue(int value)

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;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dataApiAccess to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setDataCacheConfig(DataCacheConfig value)

public Settings.Builder setDataCacheConfig(DataCacheConfig value)

Configuration for data cache.

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

Parameter
Name	Description
`value`	`DataCacheConfig`

Returns
Type	Description
`Settings.Builder`

setDataCacheConfig(DataCacheConfig.Builder builderForValue)

public Settings.Builder setDataCacheConfig(DataCacheConfig.Builder builderForValue)

Configuration for data cache.

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

Parameter
Name	Description
`builderForValue`	`DataCacheConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setDataDiskProvisionedIops(long value)

public Settings.Builder setDataDiskProvisionedIops(long value)

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];

Parameter
Name	Description
`value`	`long` The dataDiskProvisionedIops to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setDataDiskProvisionedThroughput(long value)

public Settings.Builder setDataDiskProvisionedThroughput(long value)

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];

Parameter
Name	Description
`value`	`long` The dataDiskProvisionedThroughput to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setDataDiskSizeGb(Int64Value value)

public Settings.Builder setDataDiskSizeGb(Int64Value value)

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

.google.protobuf.Int64Value data_disk_size_gb = 20;

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`Settings.Builder`

setDataDiskSizeGb(Int64Value.Builder builderForValue)

public Settings.Builder setDataDiskSizeGb(Int64Value.Builder builderForValue)

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

.google.protobuf.Int64Value data_disk_size_gb = 20;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setDataDiskType(SqlDataDiskType value)

public Settings.Builder setDataDiskType(SqlDataDiskType value)

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;

Parameter
Name	Description
`value`	`SqlDataDiskType` The dataDiskType to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setDataDiskTypeValue(int value)

public Settings.Builder setDataDiskTypeValue(int value)

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;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dataDiskType to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setDatabaseFlags(int index, DatabaseFlags value)

public Settings.Builder setDatabaseFlags(int index, DatabaseFlags value)

The database flags passed to the instance at startup.

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

Parameters
Name	Description
`index`	`int`
`value`	`DatabaseFlags`

Returns
Type	Description
`Settings.Builder`

setDatabaseFlags(int index, DatabaseFlags.Builder builderForValue)

public Settings.Builder setDatabaseFlags(int index, DatabaseFlags.Builder builderForValue)

The database flags passed to the instance at startup.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DatabaseFlags.Builder`

Returns
Type	Description
`Settings.Builder`

setDatabaseReplicationEnabled(BoolValue value)

public Settings.Builder setDatabaseReplicationEnabled(BoolValue value)

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;

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setDatabaseReplicationEnabled(BoolValue.Builder builderForValue)

public Settings.Builder setDatabaseReplicationEnabled(BoolValue.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setDeletionProtectionEnabled(BoolValue value)

public Settings.Builder setDeletionProtectionEnabled(BoolValue value)

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setDeletionProtectionEnabled(BoolValue.Builder builderForValue)

public Settings.Builder setDeletionProtectionEnabled(BoolValue.Builder builderForValue)

Configuration to protect against accidental instance deletion.

.google.protobuf.BoolValue deletion_protection_enabled = 33;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setDenyMaintenancePeriods(int index, DenyMaintenancePeriod value)

public Settings.Builder setDenyMaintenancePeriods(int index, DenyMaintenancePeriod value)

Deny maintenance periods

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

Parameters
Name	Description
`index`	`int`
`value`	`DenyMaintenancePeriod`

Returns
Type	Description
`Settings.Builder`

setDenyMaintenancePeriods(int index, DenyMaintenancePeriod.Builder builderForValue)

public Settings.Builder setDenyMaintenancePeriods(int index, DenyMaintenancePeriod.Builder builderForValue)

Deny maintenance periods

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DenyMaintenancePeriod.Builder`

Returns
Type	Description
`Settings.Builder`

setEdition(Settings.Edition value)

public Settings.Builder setEdition(Settings.Edition value)

Optional. The edition type of the Cloud SQL instance.

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

Parameter
Name	Description
`value`	`Settings.Edition` The edition to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setEditionValue(int value)

public Settings.Builder setEditionValue(int value)

Optional. The edition type of the Cloud SQL instance.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for edition to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setEnableDataplexIntegration(BoolValue value)

public Settings.Builder setEnableDataplexIntegration(BoolValue value)

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];

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setEnableDataplexIntegration(BoolValue.Builder builderForValue)

public Settings.Builder setEnableDataplexIntegration(BoolValue.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setEnableGoogleMlIntegration(BoolValue value)

public Settings.Builder setEnableGoogleMlIntegration(BoolValue value)

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

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setEnableGoogleMlIntegration(BoolValue.Builder builderForValue)

public Settings.Builder setEnableGoogleMlIntegration(BoolValue.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setEntraidConfig(SqlServerEntraIdConfig value)

public Settings.Builder setEntraidConfig(SqlServerEntraIdConfig value)

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

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

Parameter
Name	Description
`value`	`SqlServerEntraIdConfig`

Returns
Type	Description
`Settings.Builder`

setEntraidConfig(SqlServerEntraIdConfig.Builder builderForValue)

public Settings.Builder setEntraidConfig(SqlServerEntraIdConfig.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`SqlServerEntraIdConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setFinalBackupConfig(FinalBackupConfig value)

public Settings.Builder setFinalBackupConfig(FinalBackupConfig value)

Optional. The final backup configuration for the instance.

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

Parameter
Name	Description
`value`	`FinalBackupConfig`

Returns
Type	Description
`Settings.Builder`

setFinalBackupConfig(FinalBackupConfig.Builder builderForValue)

public Settings.Builder setFinalBackupConfig(FinalBackupConfig.Builder builderForValue)

Optional. The final backup configuration for the instance.

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

Parameter
Name	Description
`builderForValue`	`FinalBackupConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setInsightsConfig(InsightsConfig value)

public Settings.Builder setInsightsConfig(InsightsConfig value)

Insights configuration, for now relevant only for Postgres.

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

Parameter
Name	Description
`value`	`InsightsConfig`

Returns
Type	Description
`Settings.Builder`

setInsightsConfig(InsightsConfig.Builder builderForValue)

public Settings.Builder setInsightsConfig(InsightsConfig.Builder builderForValue)

Insights configuration, for now relevant only for Postgres.

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

Parameter
Name	Description
`builderForValue`	`InsightsConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setIpConfiguration(IpConfiguration value)

public Settings.Builder setIpConfiguration(IpConfiguration value)

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

Parameter
Name	Description
`value`	`IpConfiguration`

Returns
Type	Description
`Settings.Builder`

setIpConfiguration(IpConfiguration.Builder builderForValue)

public Settings.Builder setIpConfiguration(IpConfiguration.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`IpConfiguration.Builder`

Returns
Type	Description
`Settings.Builder`

setKind(String value)

public Settings.Builder setKind(String value)

This is always sql#settings.

string kind = 4;

Parameter
Name	Description
`value`	`String` The kind to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setKindBytes(ByteString value)

public Settings.Builder setKindBytes(ByteString value)

This is always sql#settings.

string kind = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes for kind to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setLocationPreference(LocationPreference value)

public Settings.Builder setLocationPreference(LocationPreference value)

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

Parameter
Name	Description
`value`	`LocationPreference`

Returns
Type	Description
`Settings.Builder`

setLocationPreference(LocationPreference.Builder builderForValue)

public Settings.Builder setLocationPreference(LocationPreference.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`LocationPreference.Builder`

Returns
Type	Description
`Settings.Builder`

setMaintenanceWindow(MaintenanceWindow value)

public Settings.Builder setMaintenanceWindow(MaintenanceWindow value)

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;

Parameter
Name	Description
`value`	`MaintenanceWindow`

Returns
Type	Description
`Settings.Builder`

setMaintenanceWindow(MaintenanceWindow.Builder builderForValue)

public Settings.Builder setMaintenanceWindow(MaintenanceWindow.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`MaintenanceWindow.Builder`

Returns
Type	Description
`Settings.Builder`

setPasswordValidationPolicy(PasswordValidationPolicy value)

public Settings.Builder setPasswordValidationPolicy(PasswordValidationPolicy value)

The local user password validation policy of the instance.

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

Parameter
Name	Description
`value`	`PasswordValidationPolicy`

Returns
Type	Description
`Settings.Builder`

setPasswordValidationPolicy(PasswordValidationPolicy.Builder builderForValue)

public Settings.Builder setPasswordValidationPolicy(PasswordValidationPolicy.Builder builderForValue)

The local user password validation policy of the instance.

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

Parameter
Name	Description
`builderForValue`	`PasswordValidationPolicy.Builder`

Returns
Type	Description
`Settings.Builder`

setPerformanceCaptureConfig(PerformanceCaptureConfig value)

public Settings.Builder setPerformanceCaptureConfig(PerformanceCaptureConfig value)

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];

Parameter
Name	Description
`value`	`PerformanceCaptureConfig`

Returns
Type	Description
`Settings.Builder`

setPerformanceCaptureConfig(PerformanceCaptureConfig.Builder builderForValue)

public Settings.Builder setPerformanceCaptureConfig(PerformanceCaptureConfig.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`PerformanceCaptureConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setPricingPlan(SqlPricingPlan value)

public Settings.Builder setPricingPlan(SqlPricingPlan value)

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;

Parameter
Name	Description
`value`	`SqlPricingPlan` The pricingPlan to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setPricingPlanValue(int value)

public Settings.Builder setPricingPlanValue(int value)

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;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for pricingPlan to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setReadPoolAutoScaleConfig(ReadPoolAutoScaleConfig value)

public Settings.Builder setReadPoolAutoScaleConfig(ReadPoolAutoScaleConfig value)

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];

Parameter
Name	Description
`value`	`ReadPoolAutoScaleConfig`

Returns
Type	Description
`Settings.Builder`

setReadPoolAutoScaleConfig(ReadPoolAutoScaleConfig.Builder builderForValue)

public Settings.Builder setReadPoolAutoScaleConfig(ReadPoolAutoScaleConfig.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`ReadPoolAutoScaleConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setReplicationLagMaxSeconds(Int32Value value)

public Settings.Builder setReplicationLagMaxSeconds(Int32Value value)

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

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

Parameter
Name	Description
`value`	`Int32Value`

Returns
Type	Description
`Settings.Builder`

setReplicationLagMaxSeconds(Int32Value.Builder builderForValue)

public Settings.Builder setReplicationLagMaxSeconds(Int32Value.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setReplicationType(SqlReplicationType value) (deprecated)

public Settings.Builder setReplicationType(SqlReplicationType value)

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];

Parameter
Name	Description
`value`	`SqlReplicationType` The replicationType to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setReplicationTypeValue(int value) (deprecated)

public Settings.Builder setReplicationTypeValue(int value)

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];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for replicationType to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setRetainBackupsOnDelete(BoolValue value)

public Settings.Builder setRetainBackupsOnDelete(BoolValue value)

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

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setRetainBackupsOnDelete(BoolValue.Builder builderForValue)

public Settings.Builder setRetainBackupsOnDelete(BoolValue.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setSettingsVersion(Int64Value value)

public Settings.Builder setSettingsVersion(Int64Value value)

.google.protobuf.Int64Value settings_version = 1;

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`Settings.Builder`

setSettingsVersion(Int64Value.Builder builderForValue)

public Settings.Builder setSettingsVersion(Int64Value.Builder builderForValue)

.google.protobuf.Int64Value settings_version = 1;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setSqlServerAuditConfig(SqlServerAuditConfig value)

public Settings.Builder setSqlServerAuditConfig(SqlServerAuditConfig value)

SQL Server specific audit configuration.

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

Parameter
Name	Description
`value`	`SqlServerAuditConfig`

Returns
Type	Description
`Settings.Builder`

setSqlServerAuditConfig(SqlServerAuditConfig.Builder builderForValue)

public Settings.Builder setSqlServerAuditConfig(SqlServerAuditConfig.Builder builderForValue)

SQL Server specific audit configuration.

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

Parameter
Name	Description
`builderForValue`	`SqlServerAuditConfig.Builder`

Returns
Type	Description
`Settings.Builder`

setStorageAutoResize(BoolValue value)

public Settings.Builder setStorageAutoResize(BoolValue value)

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Parameter
Name	Description
`value`	`BoolValue`

Returns
Type	Description
`Settings.Builder`

setStorageAutoResize(BoolValue.Builder builderForValue)

public Settings.Builder setStorageAutoResize(BoolValue.Builder builderForValue)

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

.google.protobuf.BoolValue storage_auto_resize = 12;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setStorageAutoResizeLimit(Int64Value value)

public Settings.Builder setStorageAutoResizeLimit(Int64Value value)

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;

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`Settings.Builder`

setStorageAutoResizeLimit(Int64Value.Builder builderForValue)

public Settings.Builder setStorageAutoResizeLimit(Int64Value.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Settings.Builder`

setTier(String value)

public Settings.Builder setTier(String value)

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

string tier = 3;

Parameter
Name	Description
`value`	`String` The tier to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setTierBytes(ByteString value)

public Settings.Builder setTierBytes(ByteString value)

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

string tier = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for tier to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setTimeZone(String value)

public Settings.Builder setTimeZone(String value)

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

string time_zone = 34;

Parameter
Name	Description
`value`	`String` The timeZone to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

setTimeZoneBytes(ByteString value)

public Settings.Builder setTimeZoneBytes(ByteString value)

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

string time_zone = 34;

Parameter
Name	Description
`value`	`ByteString` The bytes for timeZone to set.

Returns
Type	Description
`Settings.Builder`	This builder for chaining.

Class Settings.Builder (0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Methods

getDescriptor()

Methods

addAllAuthorizedGaeApplications(Iterable<String> values) (deprecated)

addAllDatabaseFlags(Iterable<? extends DatabaseFlags> values)

addAllDenyMaintenancePeriods(Iterable<? extends DenyMaintenancePeriod> values)

addAuthorizedGaeApplications(String value) (deprecated)

addAuthorizedGaeApplicationsBytes(ByteString value) (deprecated)

addDatabaseFlags(DatabaseFlags value)

addDatabaseFlags(DatabaseFlags.Builder builderForValue)

addDatabaseFlags(int index, DatabaseFlags value)

addDatabaseFlags(int index, DatabaseFlags.Builder builderForValue)

addDatabaseFlagsBuilder()

addDatabaseFlagsBuilder(int index)

addDenyMaintenancePeriods(DenyMaintenancePeriod value)

addDenyMaintenancePeriods(DenyMaintenancePeriod.Builder builderForValue)

addDenyMaintenancePeriods(int index, DenyMaintenancePeriod value)

addDenyMaintenancePeriods(int index, DenyMaintenancePeriod.Builder builderForValue)

addDenyMaintenancePeriodsBuilder()

addDenyMaintenancePeriodsBuilder(int index)

build()

buildPartial()

clear()

clearAcceleratedReplicaMode()

clearActivationPolicy()

clearActiveDirectoryConfig()

clearAdvancedMachineFeatures()

clearAuthorizedGaeApplications() (deprecated)

clearAutoUpgradeEnabled()

clearAvailabilityType()

clearBackupConfiguration()

clearCollation()

clearConnectionPoolConfig()

clearConnectorEnforcement()

clearCrashSafeReplicationEnabled() (deprecated)

clearDataApiAccess()

clearDataCacheConfig()

clearDataDiskProvisionedIops()

clearDataDiskProvisionedThroughput()

clearDataDiskSizeGb()

clearDataDiskType()

clearDatabaseFlags()

clearDatabaseReplicationEnabled()

clearDeletionProtectionEnabled()

clearDenyMaintenancePeriods()

clearEdition()

clearEnableDataplexIntegration()

clearEnableGoogleMlIntegration()

clearEntraidConfig()

clearFinalBackupConfig()

clearInsightsConfig()

clearIpConfiguration()

clearKind()

clearLocationPreference()

clearMaintenanceWindow()

clearPasswordValidationPolicy()

clearPerformanceCaptureConfig()

clearPricingPlan()

clearReadPoolAutoScaleConfig()

clearReplicationLagMaxSeconds()

clearReplicationType() (deprecated)

clearRetainBackupsOnDelete()

clearSettingsVersion()

clearSqlServerAuditConfig()

clearStorageAutoResize()

clearStorageAutoResizeLimit()

clearTier()

clearTimeZone()

clearUserLabels()

containsUserLabels(String key)

getAcceleratedReplicaMode()

getAcceleratedReplicaModeBuilder()

getAcceleratedReplicaModeOrBuilder()

getActivationPolicy()

getActivationPolicyValue()

getActiveDirectoryConfig()

Class Settings.Builder (0.1.0)