Represents a Settings.
Package
@google-cloud/sqlConstructors
(constructor)(properties)
constructor(properties?: google.cloud.sql.v1beta4.ISettings);Constructs a new Settings.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISettings
Properties to set |
Properties
activationPolicy
public activationPolicy: (google.cloud.sql.v1beta4.Settings.SqlActivationPolicy|keyof typeof google.cloud.sql.v1beta4.Settings.SqlActivationPolicy);Settings activationPolicy.
activeDirectoryConfig
public activeDirectoryConfig?: (google.cloud.sql.v1beta4.ISqlActiveDirectoryConfig|null);Settings activeDirectoryConfig.
advancedMachineFeatures
public advancedMachineFeatures?: (google.cloud.sql.v1beta4.IAdvancedMachineFeatures|null);Settings advancedMachineFeatures.
authorizedGaeApplications
public authorizedGaeApplications: string[];Settings authorizedGaeApplications.
availabilityType
public availabilityType: (google.cloud.sql.v1beta4.SqlAvailabilityType|keyof typeof google.cloud.sql.v1beta4.SqlAvailabilityType);Settings availabilityType.
backupConfiguration
public backupConfiguration?: (google.cloud.sql.v1beta4.IBackupConfiguration|null);Settings backupConfiguration.
collation
public collation: string;Settings collation.
connectorEnforcement
public connectorEnforcement: (google.cloud.sql.v1beta4.Settings.ConnectorEnforcement|keyof typeof google.cloud.sql.v1beta4.Settings.ConnectorEnforcement);Settings connectorEnforcement.
crashSafeReplicationEnabled
public crashSafeReplicationEnabled?: (google.protobuf.IBoolValue|null);Settings crashSafeReplicationEnabled.
databaseFlags
public databaseFlags: google.cloud.sql.v1beta4.IDatabaseFlags[];Settings databaseFlags.
databaseReplicationEnabled
public databaseReplicationEnabled?: (google.protobuf.IBoolValue|null);Settings databaseReplicationEnabled.
dataCacheConfig
public dataCacheConfig?: (google.cloud.sql.v1beta4.IDataCacheConfig|null);Settings dataCacheConfig.
dataDiskSizeGb
public dataDiskSizeGb?: (google.protobuf.IInt64Value|null);Settings dataDiskSizeGb.
dataDiskType
public dataDiskType: (google.cloud.sql.v1beta4.SqlDataDiskType|keyof typeof google.cloud.sql.v1beta4.SqlDataDiskType);Settings dataDiskType.
deletionProtectionEnabled
public deletionProtectionEnabled?: (google.protobuf.IBoolValue|null);Settings deletionProtectionEnabled.
denyMaintenancePeriods
public denyMaintenancePeriods: google.cloud.sql.v1beta4.IDenyMaintenancePeriod[];Settings denyMaintenancePeriods.
edition
public edition: (google.cloud.sql.v1beta4.Settings.Edition|keyof typeof google.cloud.sql.v1beta4.Settings.Edition);Settings edition.
enableDataplexIntegration
public enableDataplexIntegration?: (google.protobuf.IBoolValue|null);Settings enableDataplexIntegration.
enableGoogleMlIntegration
public enableGoogleMlIntegration?: (google.protobuf.IBoolValue|null);Settings enableGoogleMlIntegration.
insightsConfig
public insightsConfig?: (google.cloud.sql.v1beta4.IInsightsConfig|null);Settings insightsConfig.
ipConfiguration
public ipConfiguration?: (google.cloud.sql.v1beta4.IIpConfiguration|null);Settings ipConfiguration.
kind
public kind: string;Settings kind.
locationPreference
public locationPreference?: (google.cloud.sql.v1beta4.ILocationPreference|null);Settings locationPreference.
maintenanceWindow
public maintenanceWindow?: (google.cloud.sql.v1beta4.IMaintenanceWindow|null);Settings maintenanceWindow.
passwordValidationPolicy
public passwordValidationPolicy?: (google.cloud.sql.v1beta4.IPasswordValidationPolicy|null);Settings passwordValidationPolicy.
pricingPlan
public pricingPlan: (google.cloud.sql.v1beta4.SqlPricingPlan|keyof typeof google.cloud.sql.v1beta4.SqlPricingPlan);Settings pricingPlan.
replicationType
public replicationType: (google.cloud.sql.v1beta4.SqlReplicationType|keyof typeof google.cloud.sql.v1beta4.SqlReplicationType);Settings replicationType.
settingsVersion
public settingsVersion?: (google.protobuf.IInt64Value|null);Settings settingsVersion.
sqlServerAuditConfig
public sqlServerAuditConfig?: (google.cloud.sql.v1beta4.ISqlServerAuditConfig|null);Settings sqlServerAuditConfig.
storageAutoResize
public storageAutoResize?: (google.protobuf.IBoolValue|null);Settings storageAutoResize.
storageAutoResizeLimit
public storageAutoResizeLimit?: (google.protobuf.IInt64Value|null);Settings storageAutoResizeLimit.
tier
public tier: string;Settings tier.
timeZone
public timeZone: string;Settings timeZone.
userLabels
public userLabels: { [k: string]: string };Settings userLabels.
Methods
create(properties)
public static create(properties?: google.cloud.sql.v1beta4.ISettings): google.cloud.sql.v1beta4.Settings;Creates a new Settings instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISettings
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Settings |
Settings instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1beta4.Settings;Decodes a Settings message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Settings |
Settings |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1beta4.Settings;Decodes a Settings message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Settings |
Settings |
encode(message, writer)
public static encode(message: google.cloud.sql.v1beta4.ISettings, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Settings message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISettings
Settings message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.sql.v1beta4.ISettings, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Settings message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISettings
Settings message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.sql.v1beta4.Settings;Creates a Settings message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Settings |
Settings |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Settings
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Settings to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.sql.v1beta4.Settings, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Settings message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Settings
Settings |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Settings message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|