Package com.google.firestore.admin.v1

Class Backup.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Backup.Builder>
com.google.firestore.admin.v1.Backup.Builder
All Implemented Interfaces:
BackupOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Backup
public static final class Backup.Builder extends com.google.protobuf.GeneratedMessage.Builder<Backup.Builder> implements BackupOrBuilder
 A Backup of a Cloud Firestore Database.

 The backup contains all documents and index configurations for the given
 database at a specific point in time.
Protobuf type google.firestore.admin.v1.Backup

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Backup.Builder>

    • clear

      public Backup.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Backup.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Backup.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Backup.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Backup.Builder>

    • mergeFrom

      public Backup.Builder mergeFrom(Backup other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Backup.Builder>

    • mergeFrom

      public Backup.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Backup.Builder>
      Throws:
      IOException

    • getName

      public 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];
      Specified by:
      getName in interface BackupOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface BackupOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Backup.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Backup.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public Backup.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDatabase

      public 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) = { ... }
      Specified by:
      getDatabase in interface BackupOrBuilder
      Returns:
      The database.

    • getDatabaseBytes

      public 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) = { ... }
      Specified by:
      getDatabaseBytes in interface BackupOrBuilder
      Returns:
      The bytes for database.

    • setDatabase

      public Backup.Builder setDatabase(String value)
       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) = { ... }
      Parameters:
      value - The database to set.
      Returns:
      This builder for chaining.

    • clearDatabase

      public Backup.Builder clearDatabase()
       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:
      This builder for chaining.

    • setDatabaseBytes

      public Backup.Builder setDatabaseBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for database to set.
      Returns:
      This builder for chaining.

    • getDatabaseUid

      public 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];
      Specified by:
      getDatabaseUid in interface BackupOrBuilder
      Returns:
      The databaseUid.

    • getDatabaseUidBytes

      public 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];
      Specified by:
      getDatabaseUidBytes in interface BackupOrBuilder
      Returns:
      The bytes for databaseUid.

    • setDatabaseUid

      public Backup.Builder setDatabaseUid(String value)
       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];
      Parameters:
      value - The databaseUid to set.
      Returns:
      This builder for chaining.

    • clearDatabaseUid

      public Backup.Builder clearDatabaseUid()
       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:
      This builder for chaining.

    • setDatabaseUidBytes

      public Backup.Builder setDatabaseUidBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for databaseUid to set.
      Returns:
      This builder for chaining.

    • hasSnapshotTime

      public 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];
      Specified by:
      hasSnapshotTime in interface BackupOrBuilder
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      public 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];
      Specified by:
      getSnapshotTime in interface BackupOrBuilder
      Returns:
      The snapshotTime.

    • setSnapshotTime

      public Backup.Builder setSnapshotTime(com.google.protobuf.Timestamp value)
       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];

    • setSnapshotTime

      public Backup.Builder setSnapshotTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeSnapshotTime

      public Backup.Builder mergeSnapshotTime(com.google.protobuf.Timestamp value)
       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];

    • clearSnapshotTime

      public Backup.Builder clearSnapshotTime()
       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];

    • getSnapshotTimeBuilder

      public com.google.protobuf.Timestamp.Builder getSnapshotTimeBuilder()
       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];

    • getSnapshotTimeOrBuilder

      public 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];
      Specified by:
      getSnapshotTimeOrBuilder in interface BackupOrBuilder

    • hasExpireTime

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

    • getExpireTime

      public 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];
      Specified by:
      getExpireTime in interface BackupOrBuilder
      Returns:
      The expireTime.

    • setExpireTime

      public Backup.Builder setExpireTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setExpireTime

      public Backup.Builder setExpireTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeExpireTime

      public Backup.Builder mergeExpireTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearExpireTime

      public Backup.Builder clearExpireTime()
       Output only. The timestamp at which this backup expires.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getExpireTimeBuilder

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

    • getExpireTimeOrBuilder

      public 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];
      Specified by:
      getExpireTimeOrBuilder in interface BackupOrBuilder

    • hasStats

      public 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];
      Specified by:
      hasStats in interface BackupOrBuilder
      Returns:
      Whether the stats field is set.

    • getStats

      public 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];
      Specified by:
      getStats in interface BackupOrBuilder
      Returns:
      The stats.

    • setStats

      public Backup.Builder setStats(Backup.Stats value)
       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];

    • setStats

      public Backup.Builder setStats(Backup.Stats.Builder builderForValue)
       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];

    • mergeStats

      public Backup.Builder mergeStats(Backup.Stats value)
       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];

    • clearStats

      public Backup.Builder clearStats()
       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];

    • getStatsBuilder

      public Backup.Stats.Builder getStatsBuilder()
       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];

    • getStatsOrBuilder

      public 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];
      Specified by:
      getStatsOrBuilder in interface BackupOrBuilder

    • getStateValue

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

    • setStateValue

      public Backup.Builder setStateValue(int value)
       Output only. The current state of the backup.
      .google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.

    • getState

      public 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];
      Specified by:
      getState in interface BackupOrBuilder
      Returns:
      The state.

    • setState

      public Backup.Builder setState(Backup.State value)
       Output only. The current state of the backup.
      .google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • clearState

      public Backup.Builder clearState()
       Output only. The current state of the backup.
      .google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.