final case class Backup(database: String = "", expireTime: Option[Timestamp] = _root_.scala.None, name: String = "", createTime: Option[Timestamp] = _root_.scala.None, sizeBytes: Long = 0L, state: State = ..., referencingDatabases: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Backup] with Product with Serializable

A backup of a Cloud Spanner database.

database

Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

expireTime

Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

name

Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_&92;-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/<project>/instances/<instance>.

createTime

Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by create_time. create_time is approximately the time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.

sizeBytes

Output only. Size of the backup in bytes.

state

Output only. The current state of the backup.

referencingDatabases

Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[Backup], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Backup
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Backup(database: String = "", expireTime: Option[Timestamp] = _root_.scala.None, name: String = "", createTime: Option[Timestamp] = _root_.scala.None, sizeBytes: Long = 0L, state: State = ..., referencingDatabases: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    database

    Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

    expireTime

    Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

    name

    Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_&92;-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/<project>/instances/<instance>.

    createTime

    Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by create_time. create_time is approximately the time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.

    sizeBytes

    Output only. Size of the backup in bytes.

    state

    Output only. The current state of the backup.

    referencingDatabases

    Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

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 addAllReferencingDatabases(__vs: Iterable[String]): Backup
  5. def addReferencingDatabases(__vs: String*): Backup
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearCreateTime: Backup
  8. def clearExpireTime: Backup
  9. def clearReferencingDatabases: Backup
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def companion: Backup.type
    Definition Classes
    Backup → GeneratedMessage
  12. val createTime: Option[Timestamp]
  13. val database: String
  14. def discardUnknownFields: Backup
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val expireTime: Option[Timestamp]
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getCreateTime: Timestamp
  20. def getExpireTime: Timestamp
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Backup → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Backup → GeneratedMessage
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val name: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. val referencingDatabases: Seq[String]
  29. def serializedSize: Int
    Definition Classes
    Backup → GeneratedMessage
  30. val sizeBytes: Long
  31. val state: State
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  34. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  35. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  36. def toProtoString: String
    Definition Classes
    Backup → GeneratedMessage
  37. val unknownFields: UnknownFieldSet
  38. def update(ms: (Lens[Backup, Backup]) ⇒ Mutation[Backup]*): Backup
    Definition Classes
    Updatable
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  42. def withCreateTime(__v: Timestamp): Backup
  43. def withDatabase(__v: String): Backup
  44. def withExpireTime(__v: Timestamp): Backup
  45. def withName(__v: String): Backup
  46. def withReferencingDatabases(__v: Seq[String]): Backup
  47. def withSizeBytes(__v: Long): Backup
  48. def withState(__v: State): Backup
  49. def withUnknownFields(__v: UnknownFieldSet): Backup
  50. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  51. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Backup → GeneratedMessage
  52. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[Backup]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped