Package com.google.spanner.admin.database.v1

Class Backup

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.Backup
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BackupOrBuilder, Serializable
public final class Backup extends com.google.protobuf.GeneratedMessageV3 implements BackupOrBuilder
 A backup of a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Backup
See Also:

  • Field Details

    • DATABASE_FIELD_NUMBER

      public static final int DATABASE_FIELD_NUMBER
      See Also:

    • VERSION_TIME_FIELD_NUMBER

      public static final int VERSION_TIME_FIELD_NUMBER
      See Also:

    • EXPIRE_TIME_FIELD_NUMBER

      public static final int EXPIRE_TIME_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • SIZE_BYTES_FIELD_NUMBER

      public static final int SIZE_BYTES_FIELD_NUMBER
      See Also:

    • FREEABLE_SIZE_BYTES_FIELD_NUMBER

      public static final int FREEABLE_SIZE_BYTES_FIELD_NUMBER
      See Also:

    • EXCLUSIVE_SIZE_BYTES_FIELD_NUMBER

      public static final int EXCLUSIVE_SIZE_BYTES_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • REFERENCING_DATABASES_FIELD_NUMBER

      public static final int REFERENCING_DATABASES_FIELD_NUMBER
      See Also:

    • ENCRYPTION_INFO_FIELD_NUMBER

      public static final int ENCRYPTION_INFO_FIELD_NUMBER
      See Also:

    • ENCRYPTION_INFORMATION_FIELD_NUMBER

      public static final int ENCRYPTION_INFORMATION_FIELD_NUMBER
      See Also:

    • DATABASE_DIALECT_FIELD_NUMBER

      public static final int DATABASE_DIALECT_FIELD_NUMBER
      See Also:

    • REFERENCING_BACKUPS_FIELD_NUMBER

      public static final int REFERENCING_BACKUPS_FIELD_NUMBER
      See Also:

    • MAX_EXPIRE_TIME_FIELD_NUMBER

      public static final int MAX_EXPIRE_TIME_FIELD_NUMBER
      See Also:

    • BACKUP_SCHEDULES_FIELD_NUMBER

      public static final int BACKUP_SCHEDULES_FIELD_NUMBER
      See Also:

    • INCREMENTAL_BACKUP_CHAIN_ID_FIELD_NUMBER

      public static final int INCREMENTAL_BACKUP_CHAIN_ID_FIELD_NUMBER
      See Also:

    • OLDEST_VERSION_TIME_FIELD_NUMBER

      public static final int OLDEST_VERSION_TIME_FIELD_NUMBER
      See Also:

    • INSTANCE_PARTITIONS_FIELD_NUMBER

      public static final int INSTANCE_PARTITIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDatabase

      public String getDatabase()
       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>`.
      string database = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getDatabase in interface BackupOrBuilder
      Returns:
      The database.

    • getDatabaseBytes

      public com.google.protobuf.ByteString getDatabaseBytes()
       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>`.
      string database = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getDatabaseBytes in interface BackupOrBuilder
      Returns:
      The bytes for database.

    • hasVersionTime

      public boolean hasVersionTime()
       The backup will contain an externally consistent copy of the database at
 the timestamp specified by `version_time`. If `version_time` is not
 specified, the system will set `version_time` to the `create_time` of the
 backup.
      .google.protobuf.Timestamp version_time = 9;
      Specified by:
      hasVersionTime in interface BackupOrBuilder
      Returns:
      Whether the versionTime field is set.

    • getVersionTime

      public com.google.protobuf.Timestamp getVersionTime()
       The backup will contain an externally consistent copy of the database at
 the timestamp specified by `version_time`. If `version_time` is not
 specified, the system will set `version_time` to the `create_time` of the
 backup.
      .google.protobuf.Timestamp version_time = 9;
      Specified by:
      getVersionTime in interface BackupOrBuilder
      Returns:
      The versionTime.

    • getVersionTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder()
       The backup will contain an externally consistent copy of the database at
 the timestamp specified by `version_time`. If `version_time` is not
 specified, the system will set `version_time` to the `create_time` of the
 backup.
      .google.protobuf.Timestamp version_time = 9;
      Specified by:
      getVersionTimeOrBuilder in interface BackupOrBuilder

    • hasExpireTime

      public boolean hasExpireTime()
       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.
      .google.protobuf.Timestamp expire_time = 3;
      Specified by:
      hasExpireTime in interface BackupOrBuilder
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      public com.google.protobuf.Timestamp getExpireTime()
       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.
      .google.protobuf.Timestamp expire_time = 3;
      Specified by:
      getExpireTime in interface BackupOrBuilder
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       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.
      .google.protobuf.Timestamp expire_time = 3;
      Specified by:
      getExpireTimeOrBuilder in interface BackupOrBuilder

    • getName

      public String getName()
       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_\-]*[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>`.
      string name = 1;
      Specified by:
      getName in interface BackupOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       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_\-]*[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>`.
      string name = 1;
      Specified by:
      getNameBytes in interface BackupOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 request is received. If the request does not specify `version_time`, the
 `version_time` of the backup will be equivalent to the `create_time`.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface BackupOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 request is received. If the request does not specify `version_time`, the
 `version_time` of the backup will be equivalent to the `create_time`.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface BackupOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 request is received. If the request does not specify `version_time`, the
 `version_time` of the backup will be equivalent to the `create_time`.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface BackupOrBuilder

    • getSizeBytes

      public long getSizeBytes()
       Output only. Size of the backup in bytes.
      int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSizeBytes in interface BackupOrBuilder
      Returns:
      The sizeBytes.

    • getFreeableSizeBytes

      public long getFreeableSizeBytes()
       Output only. The number of bytes that will be freed by deleting this
 backup. This value will be zero if, for example, this backup is part of an
 incremental backup chain and younger backups in the chain require that we
 keep its data. For backups not in an incremental backup chain, this is
 always the size of the backup. This value may change if backups on the same
 chain get created, deleted or expired.
      int64 freeable_size_bytes = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFreeableSizeBytes in interface BackupOrBuilder
      Returns:
      The freeableSizeBytes.

    • getExclusiveSizeBytes

      public long getExclusiveSizeBytes()
       Output only. For a backup in an incremental backup chain, this is the
 storage space needed to keep the data that has changed since the previous
 backup. For all other backups, this is always the size of the backup. This
 value may change if backups on the same chain get deleted or expired.

 This field can be used to calculate the total storage space used by a set
 of backups. For example, the total space used by all backups of a database
 can be computed by summing up this field.
      int64 exclusive_size_bytes = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExclusiveSizeBytes in interface BackupOrBuilder
      Returns:
      The exclusiveSizeBytes.

    • getStateValue

      public int getStateValue()
       Output only. The current state of the backup.
      .google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface BackupOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Backup.State getState()
       Output only. The current state of the backup.
      .google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface BackupOrBuilder
      Returns:
      The state.

    • getReferencingDatabasesList

      public com.google.protobuf.ProtocolStringList getReferencingDatabasesList()
       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.
      repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingDatabasesList in interface BackupOrBuilder
      Returns:
      A list containing the referencingDatabases.

    • getReferencingDatabasesCount

      public int getReferencingDatabasesCount()
       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.
      repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingDatabasesCount in interface BackupOrBuilder
      Returns:
      The count of referencingDatabases.

    • getReferencingDatabases

      public String getReferencingDatabases(int index)
       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.
      repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingDatabases in interface BackupOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencingDatabases at the given index.

    • getReferencingDatabasesBytes

      public com.google.protobuf.ByteString getReferencingDatabasesBytes(int index)
       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.
      repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingDatabasesBytes in interface BackupOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencingDatabases at the given index.

    • hasEncryptionInfo

      public boolean hasEncryptionInfo()
       Output only. The encryption information for the backup.
      .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEncryptionInfo in interface BackupOrBuilder
      Returns:
      Whether the encryptionInfo field is set.

    • getEncryptionInfo

      public EncryptionInfo getEncryptionInfo()
       Output only. The encryption information for the backup.
      .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInfo in interface BackupOrBuilder
      Returns:
      The encryptionInfo.

    • getEncryptionInfoOrBuilder

      public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
       Output only. The encryption information for the backup.
      .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInfoOrBuilder in interface BackupOrBuilder

    • getEncryptionInformationList

      public List<EncryptionInfo> getEncryptionInformationList()
       Output only. The encryption information for the backup, whether it is
 protected by one or more KMS keys. The information includes all Cloud
 KMS key versions used to encrypt the backup. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated. At least one of the key
 versions must be available for the backup to be restored. If a key version
 is revoked in the middle of a restore, the restore behavior is undefined.
      repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInformationList in interface BackupOrBuilder

    • getEncryptionInformationOrBuilderList

      public List<? extends EncryptionInfoOrBuilder> getEncryptionInformationOrBuilderList()
       Output only. The encryption information for the backup, whether it is
 protected by one or more KMS keys. The information includes all Cloud
 KMS key versions used to encrypt the backup. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated. At least one of the key
 versions must be available for the backup to be restored. If a key version
 is revoked in the middle of a restore, the restore behavior is undefined.
      repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInformationOrBuilderList in interface BackupOrBuilder

    • getEncryptionInformationCount

      public int getEncryptionInformationCount()
       Output only. The encryption information for the backup, whether it is
 protected by one or more KMS keys. The information includes all Cloud
 KMS key versions used to encrypt the backup. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated. At least one of the key
 versions must be available for the backup to be restored. If a key version
 is revoked in the middle of a restore, the restore behavior is undefined.
      repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInformationCount in interface BackupOrBuilder

    • getEncryptionInformation

      public EncryptionInfo getEncryptionInformation(int index)
       Output only. The encryption information for the backup, whether it is
 protected by one or more KMS keys. The information includes all Cloud
 KMS key versions used to encrypt the backup. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated. At least one of the key
 versions must be available for the backup to be restored. If a key version
 is revoked in the middle of a restore, the restore behavior is undefined.
      repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInformation in interface BackupOrBuilder

    • getEncryptionInformationOrBuilder

      public EncryptionInfoOrBuilder getEncryptionInformationOrBuilder(int index)
       Output only. The encryption information for the backup, whether it is
 protected by one or more KMS keys. The information includes all Cloud
 KMS key versions used to encrypt the backup. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated. At least one of the key
 versions must be available for the backup to be restored. If a key version
 is revoked in the middle of a restore, the restore behavior is undefined.
      repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEncryptionInformationOrBuilder in interface BackupOrBuilder

    • getDatabaseDialectValue

      public int getDatabaseDialectValue()
       Output only. The database dialect information for the backup.
      .google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDatabaseDialectValue in interface BackupOrBuilder
      Returns:
      The enum numeric value on the wire for databaseDialect.

    • getDatabaseDialect

      public DatabaseDialect getDatabaseDialect()
       Output only. The database dialect information for the backup.
      .google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDatabaseDialect in interface BackupOrBuilder
      Returns:
      The databaseDialect.

    • getReferencingBackupsList

      public com.google.protobuf.ProtocolStringList getReferencingBackupsList()
       Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
      repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingBackupsList in interface BackupOrBuilder
      Returns:
      A list containing the referencingBackups.

    • getReferencingBackupsCount

      public int getReferencingBackupsCount()
       Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
      repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingBackupsCount in interface BackupOrBuilder
      Returns:
      The count of referencingBackups.

    • getReferencingBackups

      public String getReferencingBackups(int index)
       Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
      repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingBackups in interface BackupOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencingBackups at the given index.

    • getReferencingBackupsBytes

      public com.google.protobuf.ByteString getReferencingBackupsBytes(int index)
       Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
      repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getReferencingBackupsBytes in interface BackupOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencingBackups at the given index.

    • hasMaxExpireTime

      public boolean hasMaxExpireTime()
       Output only. The max allowed expiration time of the backup, with
 microseconds granularity. A backup's expiration time can be configured in
 multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
 copying an existing backup, the expiration time specified must be
 less than `Backup.max_expire_time`.
      .google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasMaxExpireTime in interface BackupOrBuilder
      Returns:
      Whether the maxExpireTime field is set.

    • getMaxExpireTime

      public com.google.protobuf.Timestamp getMaxExpireTime()
       Output only. The max allowed expiration time of the backup, with
 microseconds granularity. A backup's expiration time can be configured in
 multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
 copying an existing backup, the expiration time specified must be
 less than `Backup.max_expire_time`.
      .google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaxExpireTime in interface BackupOrBuilder
      Returns:
      The maxExpireTime.

    • getMaxExpireTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getMaxExpireTimeOrBuilder()
       Output only. The max allowed expiration time of the backup, with
 microseconds granularity. A backup's expiration time can be configured in
 multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
 copying an existing backup, the expiration time specified must be
 less than `Backup.max_expire_time`.
      .google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaxExpireTimeOrBuilder in interface BackupOrBuilder

    • getBackupSchedulesList

      public com.google.protobuf.ProtocolStringList getBackupSchedulesList()
       Output only. List of backup schedule URIs that are associated with
 creating this backup. This is only applicable for scheduled backups, and
 is empty for on-demand backups.

 To optimize for storage, whenever possible, multiple schedules are
 collapsed together to create one backup. In such cases, this field captures
 the list of all backup schedule URIs that are associated with creating
 this backup. If collapsing is not done, then this field captures the
 single backup schedule URI associated with creating this backup.
      repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getBackupSchedulesList in interface BackupOrBuilder
      Returns:
      A list containing the backupSchedules.

    • getBackupSchedulesCount

      public int getBackupSchedulesCount()
       Output only. List of backup schedule URIs that are associated with
 creating this backup. This is only applicable for scheduled backups, and
 is empty for on-demand backups.

 To optimize for storage, whenever possible, multiple schedules are
 collapsed together to create one backup. In such cases, this field captures
 the list of all backup schedule URIs that are associated with creating
 this backup. If collapsing is not done, then this field captures the
 single backup schedule URI associated with creating this backup.
      repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getBackupSchedulesCount in interface BackupOrBuilder
      Returns:
      The count of backupSchedules.

    • getBackupSchedules

      public String getBackupSchedules(int index)
       Output only. List of backup schedule URIs that are associated with
 creating this backup. This is only applicable for scheduled backups, and
 is empty for on-demand backups.

 To optimize for storage, whenever possible, multiple schedules are
 collapsed together to create one backup. In such cases, this field captures
 the list of all backup schedule URIs that are associated with creating
 this backup. If collapsing is not done, then this field captures the
 single backup schedule URI associated with creating this backup.
      repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getBackupSchedules in interface BackupOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The backupSchedules at the given index.

    • getBackupSchedulesBytes

      public com.google.protobuf.ByteString getBackupSchedulesBytes(int index)
       Output only. List of backup schedule URIs that are associated with
 creating this backup. This is only applicable for scheduled backups, and
 is empty for on-demand backups.

 To optimize for storage, whenever possible, multiple schedules are
 collapsed together to create one backup. In such cases, this field captures
 the list of all backup schedule URIs that are associated with creating
 this backup. If collapsing is not done, then this field captures the
 single backup schedule URI associated with creating this backup.
      repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getBackupSchedulesBytes in interface BackupOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the backupSchedules at the given index.

    • getIncrementalBackupChainId

      public String getIncrementalBackupChainId()
       Output only. Populated only for backups in an incremental backup chain.
 Backups share the same chain id if and only if they belong to the same
 incremental backup chain. Use this field to determine which backups are
 part of the same incremental backup chain. The ordering of backups in the
 chain can be determined by ordering the backup `version_time`.
      string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIncrementalBackupChainId in interface BackupOrBuilder
      Returns:
      The incrementalBackupChainId.

    • getIncrementalBackupChainIdBytes

      public com.google.protobuf.ByteString getIncrementalBackupChainIdBytes()
       Output only. Populated only for backups in an incremental backup chain.
 Backups share the same chain id if and only if they belong to the same
 incremental backup chain. Use this field to determine which backups are
 part of the same incremental backup chain. The ordering of backups in the
 chain can be determined by ordering the backup `version_time`.
      string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIncrementalBackupChainIdBytes in interface BackupOrBuilder
      Returns:
      The bytes for incrementalBackupChainId.

    • hasOldestVersionTime

      public boolean hasOldestVersionTime()
       Output only. Data deleted at a time older than this is guaranteed not to be
 retained in order to support this backup. For a backup in an incremental
 backup chain, this is the version time of the oldest backup that exists or
 ever existed in the chain. For all other backups, this is the version time
 of the backup. This field can be used to understand what data is being
 retained by the backup system.
      .google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasOldestVersionTime in interface BackupOrBuilder
      Returns:
      Whether the oldestVersionTime field is set.

    • getOldestVersionTime

      public com.google.protobuf.Timestamp getOldestVersionTime()
       Output only. Data deleted at a time older than this is guaranteed not to be
 retained in order to support this backup. For a backup in an incremental
 backup chain, this is the version time of the oldest backup that exists or
 ever existed in the chain. For all other backups, this is the version time
 of the backup. This field can be used to understand what data is being
 retained by the backup system.
      .google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOldestVersionTime in interface BackupOrBuilder
      Returns:
      The oldestVersionTime.

    • getOldestVersionTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getOldestVersionTimeOrBuilder()
       Output only. Data deleted at a time older than this is guaranteed not to be
 retained in order to support this backup. For a backup in an incremental
 backup chain, this is the version time of the oldest backup that exists or
 ever existed in the chain. For all other backups, this is the version time
 of the backup. This field can be used to understand what data is being
 retained by the backup system.
      .google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOldestVersionTimeOrBuilder in interface BackupOrBuilder

    • getInstancePartitionsList

      public List<BackupInstancePartition> getInstancePartitionsList()
       Output only. The instance partition(s) storing the backup.

 This is the same as the list of the instance partition(s) that the database
 had footprint in at the backup's `version_time`.
      repeated .google.spanner.admin.database.v1.BackupInstancePartition instance_partitions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancePartitionsList in interface BackupOrBuilder

    • getInstancePartitionsOrBuilderList

      public List<? extends BackupInstancePartitionOrBuilder> getInstancePartitionsOrBuilderList()
       Output only. The instance partition(s) storing the backup.

 This is the same as the list of the instance partition(s) that the database
 had footprint in at the backup's `version_time`.
      repeated .google.spanner.admin.database.v1.BackupInstancePartition instance_partitions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancePartitionsOrBuilderList in interface BackupOrBuilder

    • getInstancePartitionsCount

      public int getInstancePartitionsCount()
       Output only. The instance partition(s) storing the backup.

 This is the same as the list of the instance partition(s) that the database
 had footprint in at the backup's `version_time`.
      repeated .google.spanner.admin.database.v1.BackupInstancePartition instance_partitions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancePartitionsCount in interface BackupOrBuilder

    • getInstancePartitions

      public BackupInstancePartition getInstancePartitions(int index)
       Output only. The instance partition(s) storing the backup.

 This is the same as the list of the instance partition(s) that the database
 had footprint in at the backup's `version_time`.
      repeated .google.spanner.admin.database.v1.BackupInstancePartition instance_partitions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancePartitions in interface BackupOrBuilder

    • getInstancePartitionsOrBuilder

      public BackupInstancePartitionOrBuilder getInstancePartitionsOrBuilder(int index)
       Output only. The instance partition(s) storing the backup.

 This is the same as the list of the instance partition(s) that the database
 had footprint in at the backup's `version_time`.
      repeated .google.spanner.admin.database.v1.BackupInstancePartition instance_partitions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancePartitionsOrBuilder in interface BackupOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Backup parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Backup parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Backup parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Backup parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Backup parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Backup parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Backup parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Backup parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Backup parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Backup parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Backup parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Backup parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Backup.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Backup.Builder newBuilder()

    • newBuilder

      public static Backup.Builder newBuilder(Backup prototype)

    • toBuilder

      public Backup.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Backup.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Backup getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Backup> parser()

    • getParserForType

      public com.google.protobuf.Parser<Backup> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Backup getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder