Class protos.google.cloud.alloydb.v1.Cluster (1.6.0)

Represents a Cluster.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.alloydb.v1.ICluster);

Constructs a new Cluster.

Parameter
Name	Description
`properties`	`ICluster` Properties to set

Properties

annotations

public annotations: { [k: string]: string };

Cluster annotations.

automatedBackupPolicy

public automatedBackupPolicy?: (google.cloud.alloydb.v1.IAutomatedBackupPolicy|null);

Cluster automatedBackupPolicy.

backupSource

public backupSource?: (google.cloud.alloydb.v1.IBackupSource|null);

Cluster backupSource.

clusterType

public clusterType: (google.cloud.alloydb.v1.Cluster.ClusterType|keyof typeof google.cloud.alloydb.v1.Cluster.ClusterType);

Cluster clusterType.

continuousBackupConfig

public continuousBackupConfig?: (google.cloud.alloydb.v1.IContinuousBackupConfig|null);

Cluster continuousBackupConfig.

continuousBackupInfo

public continuousBackupInfo?: (google.cloud.alloydb.v1.IContinuousBackupInfo|null);

Cluster continuousBackupInfo.

createTime

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

Cluster createTime.

databaseVersion

public databaseVersion: (google.cloud.alloydb.v1.DatabaseVersion|keyof typeof google.cloud.alloydb.v1.DatabaseVersion);

Cluster databaseVersion.

deleteTime

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

Cluster deleteTime.

displayName

public displayName: string;

Cluster displayName.

encryptionConfig

public encryptionConfig?: (google.cloud.alloydb.v1.IEncryptionConfig|null);

Cluster encryptionConfig.

encryptionInfo

public encryptionInfo?: (google.cloud.alloydb.v1.IEncryptionInfo|null);

Cluster encryptionInfo.

etag

public etag: string;

Cluster etag.

initialUser

public initialUser?: (google.cloud.alloydb.v1.IUserPassword|null);

Cluster initialUser.

labels

public labels: { [k: string]: string };

Cluster labels.

migrationSource

public migrationSource?: (google.cloud.alloydb.v1.IMigrationSource|null);

Cluster migrationSource.

name

public name: string;

Cluster name.

network

public network: string;

Cluster network.

networkConfig

public networkConfig?: (google.cloud.alloydb.v1.Cluster.INetworkConfig|null);

Cluster networkConfig.

primaryConfig

public primaryConfig?: (google.cloud.alloydb.v1.Cluster.IPrimaryConfig|null);

Cluster primaryConfig.

reconciling

public reconciling: boolean;

Cluster reconciling.

secondaryConfig

public secondaryConfig?: (google.cloud.alloydb.v1.Cluster.ISecondaryConfig|null);

Cluster secondaryConfig.

source

public source?: ("backupSource"|"migrationSource");

Cluster source.

sslConfig

public sslConfig?: (google.cloud.alloydb.v1.ISslConfig|null);

Cluster sslConfig.

state

public state: (google.cloud.alloydb.v1.Cluster.State|keyof typeof google.cloud.alloydb.v1.Cluster.State);

Cluster state.

uid

public uid: string;

Cluster uid.

updateTime

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

Cluster updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.alloydb.v1.ICluster): google.cloud.alloydb.v1.Cluster;

Creates a new Cluster instance using the specified properties.

Parameter
Name	Description
`properties`	`ICluster` Properties to set

Returns
Type	Description
`Cluster`	Cluster instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.alloydb.v1.Cluster;

Decodes a Cluster 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
`Cluster`	Cluster

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.alloydb.v1.Cluster;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Cluster`	Cluster

encode(message, writer)

public static encode(message: google.cloud.alloydb.v1.ICluster, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Cluster message. Does not implicitly messages.

Parameters
Name	Description
`message`	`ICluster` Cluster 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.alloydb.v1.ICluster, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ICluster` Cluster 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.alloydb.v1.Cluster;

Creates a Cluster 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
`Cluster`	Cluster

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Cluster

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`Cluster` Cluster
`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 Cluster 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