Show / Hide Table of Contents

Class Settings

Database instance settings.

Inheritance
System.Object
Settings
Implements
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.SQLAdmin.v1beta4.Data
Assembly: Google.Apis.SQLAdmin.v1beta4.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
System.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

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
System.Collections.Generic.IList<System.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
System.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
System.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
System.Nullable<System.Boolean>

DatabaseFlags

The database flags passed to the instance at startup.

Declaration
[JsonProperty("databaseFlags")]
public virtual IList<DatabaseFlags> DatabaseFlags { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<DatabaseFlags>

DatabaseReplicationEnabled

Configuration specific to read replica instances. Indicates whether replication is enabled or not.

Declaration
[JsonProperty("databaseReplicationEnabled")]
public virtual bool? DatabaseReplicationEnabled { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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
System.Nullable<System.Int64>

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

DenyMaintenancePeriods

Deny maintenance periods

Declaration
[JsonProperty("denyMaintenancePeriods")]
public virtual IList<DenyMaintenancePeriod> DenyMaintenancePeriods { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<DenyMaintenancePeriod>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

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.

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

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

ReplicationType

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

Declaration
[JsonProperty("replicationType")]
public virtual string ReplicationType { get; set; }
Property Value
Type Description
System.String

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
System.Nullable<System.Int64>

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
System.Nullable<System.Boolean>

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
System.Nullable<System.Int64>

Tier

The tier (or machine type) for this instance, for example db-custom-1-3840 .

Declaration
[JsonProperty("tier")]
public virtual string Tier { get; set; }
Property Value
Type Description
System.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
System.Collections.Generic.IDictionary<System.String, System.String>

Implements

IDirectResponseSchema
In This Article
Back to top