final case class Backup(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.Backup.State.STATE_UNSPECIFIED, type: Type = com.google.cloud.alloydb.v1.resources.Backup.Type.TYPE_UNSPECIFIED, description: String = "", clusterUid: String = "", clusterName: String = "", reconciling: Boolean = false, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, sizeBytes: Long = 0L, expiryTime: Option[Timestamp] = _root_.scala.None, expiryQuantity: Option[QuantityBasedExpiry] = _root_.scala.None, databaseVersion: DatabaseVersion = com.google.cloud.alloydb.v1.resources.DatabaseVersion.DATABASE_VERSION_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Backup] with Product with Serializable
Message describing Backup object
- name
Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}- displayName
User-settable and human-readable display name for the Backup.
- 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 state of the backup.
- type
The backup type, which suggests the trigger for the backup.
- description
User-provided description of the backup.
- clusterUid
Output only. The system-generated UID of the cluster which was used to create this resource.
- clusterName
Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
- reconciling
Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
- encryptionConfig
Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- encryptionInfo
Output only. The encryption information for the backup.
- 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
- sizeBytes
Output only. The size of the backup in bytes.
- expiryTime
Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
- expiryQuantity
Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
- databaseVersion
Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
- Annotations
- @SerialVersionUID()
- Source
- Backup.scala
- Alphabetic
- By Inheritance
- Backup
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Backup(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.Backup.State.STATE_UNSPECIFIED, type: Type = com.google.cloud.alloydb.v1.resources.Backup.Type.TYPE_UNSPECIFIED, description: String = "", clusterUid: String = "", clusterName: String = "", reconciling: Boolean = false, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, sizeBytes: Long = 0L, expiryTime: Option[Timestamp] = _root_.scala.None, expiryQuantity: Option[QuantityBasedExpiry] = _root_.scala.None, databaseVersion: DatabaseVersion = com.google.cloud.alloydb.v1.resources.DatabaseVersion.DATABASE_VERSION_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- name
Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}- displayName
User-settable and human-readable display name for the Backup.
- 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 state of the backup.
- type
The backup type, which suggests the trigger for the backup.
- description
User-provided description of the backup.
- clusterUid
Output only. The system-generated UID of the cluster which was used to create this resource.
- clusterName
Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
- reconciling
Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
- encryptionConfig
Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- encryptionInfo
Output only. The encryption information for the backup.
- 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
- sizeBytes
Output only. The size of the backup in bytes.
- expiryTime
Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
- expiryQuantity
Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
- databaseVersion
Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
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)]): Backup
- def addAllLabels(__vs: Iterable[(String, String)]): Backup
- def addAnnotations(__vs: (String, String)*): Backup
- def addLabels(__vs: (String, String)*): Backup
- val annotations: Map[String, String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearAnnotations: Backup
- def clearCreateTime: Backup
- def clearDeleteTime: Backup
- def clearEncryptionConfig: Backup
- def clearEncryptionInfo: Backup
- def clearExpiryQuantity: Backup
- def clearExpiryTime: Backup
- def clearLabels: Backup
- def clearUpdateTime: Backup
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val clusterName: String
- val clusterUid: String
- def companion: Backup.type
- Definition Classes
- Backup → GeneratedMessage
- val createTime: Option[Timestamp]
- val databaseVersion: DatabaseVersion
- val deleteTime: Option[Timestamp]
- val description: String
- def discardUnknownFields: Backup
- val displayName: String
- val encryptionConfig: Option[EncryptionConfig]
- val encryptionInfo: Option[EncryptionInfo]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val etag: String
- val expiryQuantity: Option[QuantityBasedExpiry]
- val expiryTime: Option[Timestamp]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getCreateTime: Timestamp
- def getDeleteTime: Timestamp
- def getEncryptionConfig: EncryptionConfig
- def getEncryptionInfo: EncryptionInfo
- def getExpiryQuantity: QuantityBasedExpiry
- def getExpiryTime: Timestamp
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- Backup → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Backup → GeneratedMessage
- def getUpdateTime: Timestamp
- 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val reconciling: Boolean
- def serializedSize: Int
- Definition Classes
- Backup → GeneratedMessage
- val sizeBytes: Long
- 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
- Backup → GeneratedMessage
- val type: Type
- val uid: String
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Backup, Backup]) => Mutation[Backup]*): Backup
- 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]): Backup
- def withClusterName(__v: String): Backup
- def withClusterUid(__v: String): Backup
- def withCreateTime(__v: Timestamp): Backup
- def withDatabaseVersion(__v: DatabaseVersion): Backup
- def withDeleteTime(__v: Timestamp): Backup
- def withDescription(__v: String): Backup
- def withDisplayName(__v: String): Backup
- def withEncryptionConfig(__v: EncryptionConfig): Backup
- def withEncryptionInfo(__v: EncryptionInfo): Backup
- def withEtag(__v: String): Backup
- def withExpiryQuantity(__v: QuantityBasedExpiry): Backup
- def withExpiryTime(__v: Timestamp): Backup
- def withLabels(__v: Map[String, String]): Backup
- def withName(__v: String): Backup
- def withReconciling(__v: Boolean): Backup
- def withSizeBytes(__v: Long): Backup
- def withState(__v: State): Backup
- def withType(__v: Type): Backup
- def withUid(__v: String): Backup
- def withUnknownFields(__v: UnknownFieldSet): Backup
- def withUpdateTime(__v: Timestamp): Backup
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Backup → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage