Package com.google.firestore.admin.v1

Class Backup

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Backup
All Implemented Interfaces:
BackupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Backup extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Backup.Builder
    A Backup of a Cloud Firestore Database.
    static enum 
    Backup.State
    Indicate the current state of the backup.
    static final class 
    Backup.Stats
    Backup specific statistics.
    static interface 
    Backup.StatsOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATABASE_FIELD_NUMBER
     
    static final int
    DATABASE_UID_FIELD_NUMBER
     
    static final int
    EXPIRE_TIME_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SNAPSHOT_TIME_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     
    static final int
    STATS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getDatabase()
    Output only.
    com.google.protobuf.ByteString
    getDatabaseBytes()
    Output only.
    String
    getDatabaseUid()
    Output only.
    com.google.protobuf.ByteString
    getDatabaseUidBytes()
    Output only.
    static Backup
    getDefaultInstance()
     
    Backup
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Timestamp
    getExpireTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getExpireTimeOrBuilder()
    Output only.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<Backup>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.Timestamp
    getSnapshotTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getSnapshotTimeOrBuilder()
    Output only.
    Backup.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    Backup.Stats
    getStats()
    Output only.
    Backup.StatsOrBuilder
    getStatsOrBuilder()
    Output only.
    boolean
    hasExpireTime()
    Output only.
    int
    hashCode()
     
    boolean
    hasSnapshotTime()
    Output only.
    boolean
    hasStats()
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Backup.Builder
    newBuilder()
     
    static Backup.Builder
    newBuilder(Backup prototype)
     
    Backup.Builder
    newBuilderForType()
     
    protected Backup.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Backup
    parseDelimitedFrom(InputStream input)
     
    static Backup
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Backup
    parseFrom(byte[] data)
     
    static Backup
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Backup
    parseFrom(com.google.protobuf.ByteString data)
     
    static Backup
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Backup
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Backup
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Backup
    parseFrom(InputStream input)
     
    static Backup
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Backup
    parseFrom(ByteBuffer data)
     
    static Backup
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Backup>
    parser()
     
    Backup.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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