Package com.google.firestore.admin.v1

Interface BackupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Backup, Backup.Builder
@Generated public interface BackupOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. The unique resource name of the Backup.

 Format is `projects/{project}/locations/{location}/backups/{backup}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The unique resource name of the Backup.

 Format is `projects/{project}/locations/{location}/backups/{backup}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getDatabase

      String getDatabase()
       Output only. Name of the Firestore database that the backup is from.

 Format is `projects/{project}/databases/{database}`.
      string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The database.

    • getDatabaseBytes

      com.google.protobuf.ByteString getDatabaseBytes()
       Output only. Name of the Firestore database that the backup is from.

 Format is `projects/{project}/databases/{database}`.
      string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for database.

    • getDatabaseUid

      String getDatabaseUid()
       Output only. The system-generated UUID4 for the Firestore database that the
 backup is from.
      string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The databaseUid.

    • getDatabaseUidBytes

      com.google.protobuf.ByteString getDatabaseUidBytes()
       Output only. The system-generated UUID4 for the Firestore database that the
 backup is from.
      string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for databaseUid.

    • hasSnapshotTime

      boolean hasSnapshotTime()
       Output only. The backup contains an externally consistent copy of the
 database at this time.
      .google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      com.google.protobuf.Timestamp getSnapshotTime()
       Output only. The backup contains an externally consistent copy of the
 database at this time.
      .google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The snapshotTime.

    • getSnapshotTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getSnapshotTimeOrBuilder()
       Output only. The backup contains an externally consistent copy of the
 database at this time.
      .google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasExpireTime

      boolean hasExpireTime()
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.Timestamp getExpireTime()
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasStats

      boolean hasStats()
       Output only. Statistics about the backup.

 This data only becomes available after the backup is fully materialized to
 secondary storage. This field will be empty till then.
      .google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the stats field is set.

    • getStats

      Backup.Stats getStats()
       Output only. Statistics about the backup.

 This data only becomes available after the backup is fully materialized to
 secondary storage. This field will be empty till then.
      .google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The stats.

    • getStatsOrBuilder

      Backup.StatsOrBuilder getStatsOrBuilder()
       Output only. Statistics about the backup.

 This data only becomes available after the backup is fully materialized to
 secondary storage. This field will be empty till then.
      .google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateValue

      int getStateValue()
       Output only. The current state of the backup.
      .google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Backup.State getState()
       Output only. The current state of the backup.
      .google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.