Class Settings

Database instance settings.

Inheritance

object

Settings

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.SQLAdmin.v1.Data

Assembly: Google.Apis.SQLAdmin.v1.dll

Syntax

public class Settings : IDirectResponseSchema

Properties

ActivationPolicy

The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.

Declaration

[JsonProperty("activationPolicy")]
public virtual string ActivationPolicy { get; set; }

Property Value

Type	Description
string

ActiveDirectoryConfig

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

Declaration

[JsonProperty("activeDirectoryConfig")]
public virtual SqlActiveDirectoryConfig ActiveDirectoryConfig { get; set; }

Property Value

Type	Description
SqlActiveDirectoryConfig

AdvancedMachineFeatures

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

Declaration

[JsonProperty("advancedMachineFeatures")]
public virtual AdvancedMachineFeatures AdvancedMachineFeatures { get; set; }

Property Value

Type	Description
AdvancedMachineFeatures

AuthorizedGaeApplications

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

Declaration

[JsonProperty("authorizedGaeApplications")]
public virtual IList<string> AuthorizedGaeApplications { get; set; }

Property Value

Type	Description
IList<string>

AvailabilityType

Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration.

Declaration

[JsonProperty("availabilityType")]
public virtual string AvailabilityType { get; set; }

Property Value

Type	Description
string

BackupConfiguration

The daily backup configuration for the instance.

Declaration

[JsonProperty("backupConfiguration")]
public virtual BackupConfiguration BackupConfiguration { get; set; }

Property Value

Type	Description
BackupConfiguration

Collation

The name of server Instance collation.

Declaration

[JsonProperty("collation")]
public virtual string Collation { get; set; }

Property Value

Type	Description
string

ConnectionPoolConfig

Optional. The managed connection pooling configuration for the instance.

Declaration

[JsonProperty("connectionPoolConfig")]
public virtual ConnectionPoolConfig ConnectionPoolConfig { get; set; }

Property Value

Type	Description
ConnectionPoolConfig

ConnectorEnforcement

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.

Declaration

[JsonProperty("connectorEnforcement")]
public virtual string ConnectorEnforcement { get; set; }

Property Value

Type	Description
string

CrashSafeReplicationEnabled

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

Declaration

[JsonProperty("crashSafeReplicationEnabled")]
public virtual bool? CrashSafeReplicationEnabled { get; set; }

Property Value

Type	Description
bool?

DataCacheConfig

Configuration for data cache.

Declaration

[JsonProperty("dataCacheConfig")]
public virtual DataCacheConfig DataCacheConfig { get; set; }

Property Value

Type	Description
DataCacheConfig

DataDiskProvisionedIops

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

Declaration

[JsonProperty("dataDiskProvisionedIops")]
public virtual long? DataDiskProvisionedIops { get; set; }

Property Value

Type	Description
long?

DataDiskProvisionedThroughput

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

Declaration

[JsonProperty("dataDiskProvisionedThroughput")]
public virtual long? DataDiskProvisionedThroughput { get; set; }

Property Value

Type	Description
long?

DataDiskSizeGb

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

Declaration

[JsonProperty("dataDiskSizeGb")]
public virtual long? DataDiskSizeGb { get; set; }

Property Value

Type	Description
long?

DataDiskType

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

Declaration

[JsonProperty("dataDiskType")]
public virtual string DataDiskType { get; set; }

Property Value

Type	Description
string

DatabaseFlags

The database flags passed to the instance at startup.

Declaration

[JsonProperty("databaseFlags")]
public virtual IList<DatabaseFlags> DatabaseFlags { get; set; }

Property Value

Type	Description
IList<DatabaseFlags>

DatabaseReplicationEnabled

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

Declaration

[JsonProperty("databaseReplicationEnabled")]
public virtual bool? DatabaseReplicationEnabled { get; set; }

Property Value

Type	Description
bool?

DeletionProtectionEnabled

Configuration to protect against accidental instance deletion.

Declaration

[JsonProperty("deletionProtectionEnabled")]
public virtual bool? DeletionProtectionEnabled { get; set; }

Property Value

Type	Description
bool?

DenyMaintenancePeriods

Deny maintenance periods

Declaration

[JsonProperty("denyMaintenancePeriods")]
public virtual IList<DenyMaintenancePeriod> DenyMaintenancePeriods { get; set; }

Property Value

Type	Description
IList<DenyMaintenancePeriod>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Edition

Optional. The edition of the instance.

Declaration

[JsonProperty("edition")]
public virtual string Edition { get; set; }

Property Value

Type	Description
string

EnableDataplexIntegration

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.

Declaration

[JsonProperty("enableDataplexIntegration")]
public virtual bool? EnableDataplexIntegration { get; set; }

Property Value

Type	Description
bool?

EnableGoogleMlIntegration

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.

Declaration

[JsonProperty("enableGoogleMlIntegration")]
public virtual bool? EnableGoogleMlIntegration { get; set; }

Property Value

Type	Description
bool?

InsightsConfig

Insights configuration, for now relevant only for Postgres.

Declaration

[JsonProperty("insightsConfig")]
public virtual InsightsConfig InsightsConfig { get; set; }

Property Value

Type	Description
InsightsConfig

IpConfiguration

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.

Declaration

[JsonProperty("ipConfiguration")]
public virtual IpConfiguration IpConfiguration { get; set; }

Property Value

Type	Description
IpConfiguration

Kind

This is always sql#settings.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

LocationPreference

The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.

Declaration

[JsonProperty("locationPreference")]
public virtual LocationPreference LocationPreference { get; set; }

Property Value

Type	Description
LocationPreference

MaintenanceWindow

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

Declaration

[JsonProperty("maintenanceWindow")]
public virtual MaintenanceWindow MaintenanceWindow { get; set; }

Property Value

Type	Description
MaintenanceWindow

PasswordValidationPolicy

The local user password validation policy of the instance.

Declaration

[JsonProperty("passwordValidationPolicy")]
public virtual PasswordValidationPolicy PasswordValidationPolicy { get; set; }

Property Value

Type	Description
PasswordValidationPolicy

PricingPlan

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

Declaration

[JsonProperty("pricingPlan")]
public virtual string PricingPlan { get; set; }

Property Value

Type	Description
string

ReplicationLagMaxSeconds

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

Declaration

[JsonProperty("replicationLagMaxSeconds")]
public virtual int? ReplicationLagMaxSeconds { get; set; }

Property Value

Type	Description
int?

ReplicationType

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

Declaration

[JsonProperty("replicationType")]
public virtual string ReplicationType { get; set; }

Property Value

Type	Description
string

RetainBackupsOnDelete

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.

Declaration

[JsonProperty("retainBackupsOnDelete")]
public virtual bool? RetainBackupsOnDelete { get; set; }

Property Value

Type	Description
bool?

SettingsVersion

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

Declaration

[JsonProperty("settingsVersion")]
public virtual long? SettingsVersion { get; set; }

Property Value

Type	Description
long?

SqlServerAuditConfig

SQL Server specific audit configuration.

Declaration

[JsonProperty("sqlServerAuditConfig")]
public virtual SqlServerAuditConfig SqlServerAuditConfig { get; set; }

Property Value

Type	Description
SqlServerAuditConfig

StorageAutoResize

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

Declaration

[JsonProperty("storageAutoResize")]
public virtual bool? StorageAutoResize { get; set; }

Property Value

Type	Description
bool?

StorageAutoResizeLimit

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

Declaration

[JsonProperty("storageAutoResizeLimit")]
public virtual long? StorageAutoResizeLimit { get; set; }

Property Value

Type	Description
long?

Tier

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

Declaration

[JsonProperty("tier")]
public virtual string Tier { get; set; }

Property Value

Type	Description
string

TimeZone

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

Declaration

[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }

Property Value

Type	Description
string

UserLabels

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

Declaration

[JsonProperty("userLabels")]
public virtual IDictionary<string, string> UserLabels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Implements

IDirectResponseSchema