final case class Cluster(source: Source = com.google.cloud.alloydb.v1.resources.Cluster.Source.Empty, name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Cluster.State.STATE_UNSPECIFIED, clusterType: ClusterType = com.google.cloud.alloydb.v1.resources.Cluster.ClusterType.CLUSTER_TYPE_UNSPECIFIED, databaseVersion: DatabaseVersion = com.google.cloud.alloydb.v1.resources.DatabaseVersion.DATABASE_VERSION_UNSPECIFIED, network: String = "", etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, reconciling: Boolean = false, initialUser: Option[UserPassword] = _root_.scala.None, automatedBackupPolicy: Option[AutomatedBackupPolicy] = _root_.scala.None, sslConfig: Option[SslConfig] = _root_.scala.None, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, secondaryConfig: Option[SecondaryConfig] = _root_.scala.None, primaryConfig: Option[PrimaryConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Cluster] with Product with Serializable
A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
- name
Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}- displayName
User-settable and human-readable display name for the Cluster.
- uid
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- createTime
Output only. Create time stamp
- updateTime
Output only. Update time stamp
- deleteTime
Output only. Delete time stamp
- labels
Labels as key value pairs
- state
Output only. The current serving state of the cluster.
- clusterType
Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateClustervs.CreateSecondaryCluster- databaseVersion
Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- network
Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.
- etag
For Resource freshness validation (https://google.aip.dev/154)
- annotations
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- reconciling
Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- initialUser
Input only. Initial user to setup during cluster creation. Required. If used in
RestoreClusterthis is ignored.- automatedBackupPolicy
The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- sslConfig
SSL configuration for this AlloyDB Cluster.
- encryptionConfig
Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- encryptionInfo
Output only. The encryption information for the cluster.
- secondaryConfig
Cross Region replication config specific to SECONDARY cluster.
- primaryConfig
Output only. Cross Region replication config specific to PRIMARY cluster.
- Annotations
- @SerialVersionUID()
- Source
- Cluster.scala
- Alphabetic
- By Inheritance
- Cluster
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Cluster(source: Source = com.google.cloud.alloydb.v1.resources.Cluster.Source.Empty, name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Cluster.State.STATE_UNSPECIFIED, clusterType: ClusterType = com.google.cloud.alloydb.v1.resources.Cluster.ClusterType.CLUSTER_TYPE_UNSPECIFIED, databaseVersion: DatabaseVersion = com.google.cloud.alloydb.v1.resources.DatabaseVersion.DATABASE_VERSION_UNSPECIFIED, network: String = "", etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, reconciling: Boolean = false, initialUser: Option[UserPassword] = _root_.scala.None, automatedBackupPolicy: Option[AutomatedBackupPolicy] = _root_.scala.None, sslConfig: Option[SslConfig] = _root_.scala.None, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, secondaryConfig: Option[SecondaryConfig] = _root_.scala.None, primaryConfig: Option[PrimaryConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- name
Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}- displayName
User-settable and human-readable display name for the Cluster.
- uid
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- createTime
Output only. Create time stamp
- updateTime
Output only. Update time stamp
- deleteTime
Output only. Delete time stamp
- labels
Labels as key value pairs
- state
Output only. The current serving state of the cluster.
- clusterType
Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateClustervs.CreateSecondaryCluster- databaseVersion
Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- network
Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.
- etag
For Resource freshness validation (https://google.aip.dev/154)
- annotations
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- reconciling
Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- initialUser
Input only. Initial user to setup during cluster creation. Required. If used in
RestoreClusterthis is ignored.- automatedBackupPolicy
The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- sslConfig
SSL configuration for this AlloyDB Cluster.
- encryptionConfig
Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- encryptionInfo
Output only. The encryption information for the cluster.
- secondaryConfig
Cross Region replication config specific to SECONDARY cluster.
- primaryConfig
Output only. Cross Region replication config specific to PRIMARY cluster.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllAnnotations(__vs: Iterable[(String, String)]): Cluster
- def addAllLabels(__vs: Iterable[(String, String)]): Cluster
- def addAnnotations(__vs: (String, String)*): Cluster
- def addLabels(__vs: (String, String)*): Cluster
- val annotations: Map[String, String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val automatedBackupPolicy: Option[AutomatedBackupPolicy]
- def clearAnnotations: Cluster
- def clearAutomatedBackupPolicy: Cluster
- def clearCreateTime: Cluster
- def clearDeleteTime: Cluster
- def clearEncryptionConfig: Cluster
- def clearEncryptionInfo: Cluster
- def clearInitialUser: Cluster
- def clearLabels: Cluster
- def clearPrimaryConfig: Cluster
- def clearSecondaryConfig: Cluster
- def clearSource: Cluster
- def clearSslConfig: Cluster
- def clearUpdateTime: Cluster
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val clusterType: ClusterType
- def companion: Cluster.type
- Definition Classes
- Cluster → GeneratedMessage
- val createTime: Option[Timestamp]
- val databaseVersion: DatabaseVersion
- val deleteTime: Option[Timestamp]
- def discardUnknownFields: Cluster
- val displayName: String
- val encryptionConfig: Option[EncryptionConfig]
- val encryptionInfo: Option[EncryptionInfo]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val etag: String
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getAutomatedBackupPolicy: AutomatedBackupPolicy
- def getBackupSource: BackupSource
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getCreateTime: Timestamp
- def getDeleteTime: Timestamp
- def getEncryptionConfig: EncryptionConfig
- def getEncryptionInfo: EncryptionInfo
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- Cluster → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Cluster → GeneratedMessage
- def getInitialUser: UserPassword
- def getMigrationSource: MigrationSource
- def getPrimaryConfig: PrimaryConfig
- def getSecondaryConfig: SecondaryConfig
- def getSslConfig: SslConfig
- def getUpdateTime: Timestamp
- val initialUser: Option[UserPassword]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val labels: Map[String, String]
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val network: String
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val primaryConfig: Option[PrimaryConfig]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val reconciling: Boolean
- val secondaryConfig: Option[SecondaryConfig]
- def serializedSize: Int
- Definition Classes
- Cluster → GeneratedMessage
- val source: Source
- val sslConfig: Option[SslConfig]
- val state: State
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- Cluster → GeneratedMessage
- val uid: String
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Cluster, Cluster]) => Mutation[Cluster]*): Cluster
- Definition Classes
- Updatable
- val updateTime: Option[Timestamp]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAnnotations(__v: Map[String, String]): Cluster
- def withAutomatedBackupPolicy(__v: AutomatedBackupPolicy): Cluster
- def withBackupSource(__v: BackupSource): Cluster
- def withClusterType(__v: ClusterType): Cluster
- def withCreateTime(__v: Timestamp): Cluster
- def withDatabaseVersion(__v: DatabaseVersion): Cluster
- def withDeleteTime(__v: Timestamp): Cluster
- def withDisplayName(__v: String): Cluster
- def withEncryptionConfig(__v: EncryptionConfig): Cluster
- def withEncryptionInfo(__v: EncryptionInfo): Cluster
- def withEtag(__v: String): Cluster
- def withInitialUser(__v: UserPassword): Cluster
- def withLabels(__v: Map[String, String]): Cluster
- def withMigrationSource(__v: MigrationSource): Cluster
- def withName(__v: String): Cluster
- def withNetwork(__v: String): Cluster
- def withPrimaryConfig(__v: PrimaryConfig): Cluster
- def withReconciling(__v: Boolean): Cluster
- def withSecondaryConfig(__v: SecondaryConfig): Cluster
- def withSource(__v: Source): Cluster
- def withSslConfig(__v: SslConfig): Cluster
- def withState(__v: State): Cluster
- def withUid(__v: String): Cluster
- def withUnknownFields(__v: UnknownFieldSet): Cluster
- def withUpdateTime(__v: Timestamp): Cluster
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Cluster → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage