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, networkConfig: Option[NetworkConfig] = _root_.scala.None, 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, continuousBackupConfig: Option[ContinuousBackupConfig] = _root_.scala.None, continuousBackupInfo: Option[ContinuousBackupInfo] = _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. CreateCluster vs. CreateSecondaryCluster

databaseVersion

Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.

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}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.

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 RestoreCluster this 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.

continuousBackupConfig

Optional. Continuous backup configuration for this cluster.

continuousBackupInfo

Output only. Continuous backup properties for this 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
Linear Supertypes
Updatable[Cluster], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Cluster
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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, networkConfig: Option[NetworkConfig] = _root_.scala.None, 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, continuousBackupConfig: Option[ContinuousBackupConfig] = _root_.scala.None, continuousBackupInfo: Option[ContinuousBackupInfo] = _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. CreateCluster vs. CreateSecondaryCluster

    databaseVersion

    Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.

    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}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.

    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 RestoreCluster this 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.

    continuousBackupConfig

    Optional. Continuous backup configuration for this cluster.

    continuousBackupInfo

    Output only. Continuous backup properties for this cluster.

    secondaryConfig

    Cross Region replication config specific to SECONDARY cluster.

    primaryConfig

    Output only. Cross Region replication config specific to PRIMARY cluster.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllAnnotations(__vs: Iterable[(String, String)]): Cluster
  5. def addAllLabels(__vs: Iterable[(String, String)]): Cluster
  6. def addAnnotations(__vs: (String, String)*): Cluster
  7. def addLabels(__vs: (String, String)*): Cluster
  8. val annotations: Map[String, String]
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val automatedBackupPolicy: Option[AutomatedBackupPolicy]
  11. def clearAnnotations: Cluster
  12. def clearAutomatedBackupPolicy: Cluster
  13. def clearContinuousBackupConfig: Cluster
  14. def clearContinuousBackupInfo: Cluster
  15. def clearCreateTime: Cluster
  16. def clearDeleteTime: Cluster
  17. def clearEncryptionConfig: Cluster
  18. def clearEncryptionInfo: Cluster
  19. def clearInitialUser: Cluster
  20. def clearLabels: Cluster
  21. def clearNetworkConfig: Cluster
  22. def clearPrimaryConfig: Cluster
  23. def clearSecondaryConfig: Cluster
  24. def clearSource: Cluster
  25. def clearSslConfig: Cluster
  26. def clearUpdateTime: Cluster
  27. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  28. val clusterType: ClusterType
  29. def companion: Cluster.type
    Definition Classes
    Cluster → GeneratedMessage
  30. val continuousBackupConfig: Option[ContinuousBackupConfig]
  31. val continuousBackupInfo: Option[ContinuousBackupInfo]
  32. val createTime: Option[Timestamp]
  33. val databaseVersion: DatabaseVersion
  34. val deleteTime: Option[Timestamp]
  35. def discardUnknownFields: Cluster
  36. val displayName: String
  37. val encryptionConfig: Option[EncryptionConfig]
  38. val encryptionInfo: Option[EncryptionInfo]
  39. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. val etag: String
  41. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  42. def getAutomatedBackupPolicy: AutomatedBackupPolicy
  43. def getBackupSource: BackupSource
  44. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def getContinuousBackupConfig: ContinuousBackupConfig
  46. def getContinuousBackupInfo: ContinuousBackupInfo
  47. def getCreateTime: Timestamp
  48. def getDeleteTime: Timestamp
  49. def getEncryptionConfig: EncryptionConfig
  50. def getEncryptionInfo: EncryptionInfo
  51. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Cluster → GeneratedMessage
  52. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Cluster → GeneratedMessage
  53. def getInitialUser: UserPassword
  54. def getMigrationSource: MigrationSource
  55. def getNetworkConfig: NetworkConfig
  56. def getPrimaryConfig: PrimaryConfig
  57. def getSecondaryConfig: SecondaryConfig
  58. def getSslConfig: SslConfig
  59. def getUpdateTime: Timestamp
  60. val initialUser: Option[UserPassword]
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. val labels: Map[String, String]
  63. val name: String
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. val networkConfig: Option[NetworkConfig]
  66. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  67. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. val primaryConfig: Option[PrimaryConfig]
  69. def productElementNames: Iterator[String]
    Definition Classes
    Product
  70. val reconciling: Boolean
  71. val secondaryConfig: Option[SecondaryConfig]
  72. def serializedSize: Int
    Definition Classes
    Cluster → GeneratedMessage
  73. val source: Source
  74. val state: State
  75. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  76. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  77. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  78. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  79. def toProtoString: String
    Definition Classes
    Cluster → GeneratedMessage
  80. val uid: String
  81. val unknownFields: UnknownFieldSet
  82. def update(ms: (Lens[Cluster, Cluster]) => Mutation[Cluster]*): Cluster
    Definition Classes
    Updatable
  83. val updateTime: Option[Timestamp]
  84. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. def withAnnotations(__v: Map[String, String]): Cluster
  88. def withAutomatedBackupPolicy(__v: AutomatedBackupPolicy): Cluster
  89. def withBackupSource(__v: BackupSource): Cluster
  90. def withClusterType(__v: ClusterType): Cluster
  91. def withContinuousBackupConfig(__v: ContinuousBackupConfig): Cluster
  92. def withContinuousBackupInfo(__v: ContinuousBackupInfo): Cluster
  93. def withCreateTime(__v: Timestamp): Cluster
  94. def withDatabaseVersion(__v: DatabaseVersion): Cluster
  95. def withDeleteTime(__v: Timestamp): Cluster
  96. def withDisplayName(__v: String): Cluster
  97. def withEncryptionConfig(__v: EncryptionConfig): Cluster
  98. def withEncryptionInfo(__v: EncryptionInfo): Cluster
  99. def withEtag(__v: String): Cluster
  100. def withInitialUser(__v: UserPassword): Cluster
  101. def withLabels(__v: Map[String, String]): Cluster
  102. def withMigrationSource(__v: MigrationSource): Cluster
  103. def withName(__v: String): Cluster
  104. def withNetwork(__v: String): Cluster
  105. def withNetworkConfig(__v: NetworkConfig): Cluster
  106. def withPrimaryConfig(__v: PrimaryConfig): Cluster
  107. def withReconciling(__v: Boolean): Cluster
  108. def withSecondaryConfig(__v: SecondaryConfig): Cluster
  109. def withSource(__v: Source): Cluster
  110. def withSslConfig(__v: SslConfig): Cluster
  111. def withState(__v: State): Cluster
  112. def withUid(__v: String): Cluster
  113. def withUnknownFields(__v: UnknownFieldSet): Cluster
  114. def withUpdateTime(__v: Timestamp): Cluster
  115. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  116. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Cluster → GeneratedMessage
  117. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val network: String
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  2. val sslConfig: Option[SslConfig]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from Updatable[Cluster]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped