Class protos.google.cloud.sql.v1beta4.DatabaseInstance (0.14.0)

Represents a DatabaseInstance.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1beta4.IDatabaseInstance);

Constructs a new DatabaseInstance.

Parameter
Name Description
properties IDatabaseInstance

Properties to set

Properties

_dnsName

public _dnsName?: "dnsName";

DatabaseInstance _dnsName.

_geminiConfig

public _geminiConfig?: "geminiConfig";

DatabaseInstance _geminiConfig.

_outOfDiskReport

public _outOfDiskReport?: "outOfDiskReport";

DatabaseInstance _outOfDiskReport.

_primaryDnsName

public _primaryDnsName?: "primaryDnsName";

DatabaseInstance _primaryDnsName.

public _pscServiceAttachmentLink?: "pscServiceAttachmentLink";

DatabaseInstance _pscServiceAttachmentLink.

_replicationCluster

public _replicationCluster?: "replicationCluster";

DatabaseInstance _replicationCluster.

_sqlNetworkArchitecture

public _sqlNetworkArchitecture?: "sqlNetworkArchitecture";

DatabaseInstance _sqlNetworkArchitecture.

_writeEndpoint

public _writeEndpoint?: "writeEndpoint";

DatabaseInstance _writeEndpoint.

availableMaintenanceVersions

public availableMaintenanceVersions: string[];

DatabaseInstance availableMaintenanceVersions.

backendType

public backendType: (google.cloud.sql.v1beta4.SqlBackendType|keyof typeof google.cloud.sql.v1beta4.SqlBackendType);

DatabaseInstance backendType.

connectionName

public connectionName: string;

DatabaseInstance connectionName.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

DatabaseInstance createTime.

currentDiskSize

public currentDiskSize?: (google.protobuf.IInt64Value|null);

DatabaseInstance currentDiskSize.

databaseInstalledVersion

public databaseInstalledVersion: string;

DatabaseInstance databaseInstalledVersion.

databaseVersion

public databaseVersion: (google.cloud.sql.v1beta4.SqlDatabaseVersion|keyof typeof google.cloud.sql.v1beta4.SqlDatabaseVersion);

DatabaseInstance databaseVersion.

diskEncryptionConfiguration

public diskEncryptionConfiguration?: (google.cloud.sql.v1beta4.IDiskEncryptionConfiguration|null);

DatabaseInstance diskEncryptionConfiguration.

diskEncryptionStatus

public diskEncryptionStatus?: (google.cloud.sql.v1beta4.IDiskEncryptionStatus|null);

DatabaseInstance diskEncryptionStatus.

dnsName

public dnsName?: (string|null);

DatabaseInstance dnsName.

etag

public etag: string;

DatabaseInstance etag.

failoverReplica

public failoverReplica?: (google.cloud.sql.v1beta4.DatabaseInstance.ISqlFailoverReplica|null);

DatabaseInstance failoverReplica.

gceZone

public gceZone: string;

DatabaseInstance gceZone.

geminiConfig

public geminiConfig?: (google.cloud.sql.v1beta4.IGeminiInstanceConfig|null);

DatabaseInstance geminiConfig.

instanceType

public instanceType: (google.cloud.sql.v1beta4.SqlInstanceType|keyof typeof google.cloud.sql.v1beta4.SqlInstanceType);

DatabaseInstance instanceType.

ipAddresses

public ipAddresses: google.cloud.sql.v1beta4.IIpMapping[];

DatabaseInstance ipAddresses.

ipv6Address

public ipv6Address: string;

DatabaseInstance ipv6Address.

kind

public kind: string;

DatabaseInstance kind.

maintenanceVersion

public maintenanceVersion: string;

DatabaseInstance maintenanceVersion.

masterInstanceName

public masterInstanceName: string;

DatabaseInstance masterInstanceName.

maxDiskSize

public maxDiskSize?: (google.protobuf.IInt64Value|null);

DatabaseInstance maxDiskSize.

name

public name: string;

DatabaseInstance name.

onPremisesConfiguration

public onPremisesConfiguration?: (google.cloud.sql.v1beta4.IOnPremisesConfiguration|null);

DatabaseInstance onPremisesConfiguration.

outOfDiskReport

public outOfDiskReport?: (google.cloud.sql.v1beta4.DatabaseInstance.ISqlOutOfDiskReport|null);

DatabaseInstance outOfDiskReport.

primaryDnsName

public primaryDnsName?: (string|null);

DatabaseInstance primaryDnsName.

project

public project: string;

DatabaseInstance project.

public pscServiceAttachmentLink?: (string|null);

DatabaseInstance pscServiceAttachmentLink.

region

public region: string;

DatabaseInstance region.

replicaConfiguration

public replicaConfiguration?: (google.cloud.sql.v1beta4.IReplicaConfiguration|null);

DatabaseInstance replicaConfiguration.

replicaNames

public replicaNames: string[];

DatabaseInstance replicaNames.

replicationCluster

public replicationCluster?: (google.cloud.sql.v1beta4.IReplicationCluster|null);

DatabaseInstance replicationCluster.

rootPassword

public rootPassword: string;

DatabaseInstance rootPassword.

satisfiesPzs

public satisfiesPzs?: (google.protobuf.IBoolValue|null);

DatabaseInstance satisfiesPzs.

scheduledMaintenance

public scheduledMaintenance?: (google.cloud.sql.v1beta4.DatabaseInstance.ISqlScheduledMaintenance|null);

DatabaseInstance scheduledMaintenance.

secondaryGceZone

public secondaryGceZone: string;

DatabaseInstance secondaryGceZone.

public selfLink: string;

DatabaseInstance selfLink.

serverCaCert

public serverCaCert?: (google.cloud.sql.v1beta4.ISslCert|null);

DatabaseInstance serverCaCert.

serviceAccountEmailAddress

public serviceAccountEmailAddress: string;

DatabaseInstance serviceAccountEmailAddress.

settings

public settings?: (google.cloud.sql.v1beta4.ISettings|null);

DatabaseInstance settings.

sqlNetworkArchitecture

public sqlNetworkArchitecture?: (google.cloud.sql.v1beta4.DatabaseInstance.SqlNetworkArchitecture|keyof typeof google.cloud.sql.v1beta4.DatabaseInstance.SqlNetworkArchitecture|null);

DatabaseInstance sqlNetworkArchitecture.

state

public state: (google.cloud.sql.v1beta4.DatabaseInstance.SqlInstanceState|keyof typeof google.cloud.sql.v1beta4.DatabaseInstance.SqlInstanceState);

DatabaseInstance state.

suspensionReason

public suspensionReason: google.cloud.sql.v1beta4.SqlSuspensionReason[];

DatabaseInstance suspensionReason.

writeEndpoint

public writeEndpoint?: (string|null);

DatabaseInstance writeEndpoint.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1beta4.IDatabaseInstance): google.cloud.sql.v1beta4.DatabaseInstance;

Creates a new DatabaseInstance instance using the specified properties.

Parameter
Name Description
properties IDatabaseInstance

Properties to set

Returns
Type Description
DatabaseInstance

DatabaseInstance instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1beta4.DatabaseInstance;

Decodes a DatabaseInstance 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
DatabaseInstance

DatabaseInstance

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1beta4.DatabaseInstance;

Decodes a DatabaseInstance message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DatabaseInstance

DatabaseInstance

encode(message, writer)

public static encode(message: google.cloud.sql.v1beta4.IDatabaseInstance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DatabaseInstance message. Does not implicitly messages.

Parameters
Name Description
message IDatabaseInstance

DatabaseInstance 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.IDatabaseInstance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DatabaseInstance message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IDatabaseInstance

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

Creates a DatabaseInstance 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
DatabaseInstance

DatabaseInstance

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DatabaseInstance

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 DatabaseInstance to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.sql.v1beta4.DatabaseInstance, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a DatabaseInstance message. Also converts values to other types if specified.

Parameters
Name Description
message DatabaseInstance

DatabaseInstance

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

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not