Package com.google.firestore.admin.v1

Class BackupSchedule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.BackupSchedule
All Implemented Interfaces:
BackupScheduleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BackupSchedule extends com.google.protobuf.GeneratedMessage implements BackupScheduleOrBuilder
 A backup schedule for a Cloud Firestore Database.

 This resource is owned by the database it is backing up, and is deleted along
 with the database. The actual backups are not though.
Protobuf type google.firestore.admin.v1.BackupSchedule
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BackupSchedule.Builder
    A backup schedule for a Cloud Firestore Database.
    static enum 
    BackupSchedule.RecurrenceCase
     

    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
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    DAILY_RECURRENCE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RETENTION_FIELD_NUMBER
     
    static final int
    UPDATE_TIME_FIELD_NUMBER
     
    static final int
    WEEKLY_RECURRENCE_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)
     
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    DailyRecurrence
    getDailyRecurrence()
    For a schedule that runs daily.
    DailyRecurrenceOrBuilder
    getDailyRecurrenceOrBuilder()
    For a schedule that runs daily.
    static BackupSchedule
    getDefaultInstance()
     
    BackupSchedule
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<BackupSchedule>
    getParserForType()
     
    BackupSchedule.RecurrenceCase
    getRecurrenceCase()
     
    com.google.protobuf.Duration
    getRetention()
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    com.google.protobuf.DurationOrBuilder
    getRetentionOrBuilder()
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    int
    getSerializedSize()
     
    com.google.protobuf.Timestamp
    getUpdateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getUpdateTimeOrBuilder()
    Output only.
    WeeklyRecurrence
    getWeeklyRecurrence()
    For a schedule that runs weekly on a specific day.
    WeeklyRecurrenceOrBuilder
    getWeeklyRecurrenceOrBuilder()
    For a schedule that runs weekly on a specific day.
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasDailyRecurrence()
    For a schedule that runs daily.
    int
    hashCode()
     
    boolean
    hasRetention()
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    boolean
    hasUpdateTime()
    Output only.
    boolean
    hasWeeklyRecurrence()
    For a schedule that runs weekly on a specific day.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BackupSchedule.Builder
    newBuilder()
     
    static BackupSchedule.Builder
    newBuilder(BackupSchedule prototype)
     
    BackupSchedule.Builder
    newBuilderForType()
     
    protected BackupSchedule.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static BackupSchedule
    parseDelimitedFrom(InputStream input)
     
    static BackupSchedule
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackupSchedule
    parseFrom(byte[] data)
     
    static BackupSchedule
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackupSchedule
    parseFrom(com.google.protobuf.ByteString data)
     
    static BackupSchedule
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackupSchedule
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BackupSchedule
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackupSchedule
    parseFrom(InputStream input)
     
    static BackupSchedule
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackupSchedule
    parseFrom(ByteBuffer data)
     
    static BackupSchedule
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BackupSchedule>
    parser()
     
    BackupSchedule.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

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

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • RETENTION_FIELD_NUMBER

      public static final int RETENTION_FIELD_NUMBER
      See Also:

    • DAILY_RECURRENCE_FIELD_NUMBER

      public static final int DAILY_RECURRENCE_FIELD_NUMBER
      See Also:

    • WEEKLY_RECURRENCE_FIELD_NUMBER

      public static final int WEEKLY_RECURRENCE_FIELD_NUMBER
      See Also:

  • 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

    • getRecurrenceCase

      public BackupSchedule.RecurrenceCase getRecurrenceCase()
      Specified by:
      getRecurrenceCase in interface BackupScheduleOrBuilder

    • getName

      public String getName()
       Output only. The unique backup schedule identifier across all locations and
 databases for the given project.

 This will be auto-assigned.

 Format is
 `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface BackupScheduleOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The unique backup schedule identifier across all locations and
 databases for the given project.

 This will be auto-assigned.

 Format is
 `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface BackupScheduleOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp at which this backup schedule was created and
 effective since.

 No backups will be created for this schedule before this time.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface BackupScheduleOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp at which this backup schedule was created and
 effective since.

 No backups will be created for this schedule before this time.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface BackupScheduleOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp at which this backup schedule was created and
 effective since.

 No backups will be created for this schedule before this time.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface BackupScheduleOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The timestamp at which this backup schedule was most recently
 updated. When a backup schedule is first created, this is the same as
 create_time.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface BackupScheduleOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp at which this backup schedule was most recently
 updated. When a backup schedule is first created, this is the same as
 create_time.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface BackupScheduleOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp at which this backup schedule was most recently
 updated. When a backup schedule is first created, this is the same as
 create_time.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface BackupScheduleOrBuilder

    • hasRetention

      public boolean hasRetention()
       At what relative time in the future, compared to its creation time,
 the backup should be deleted, e.g. keep backups for 7 days.

 The maximum supported retention period is 14 weeks.
      .google.protobuf.Duration retention = 6;
      Specified by:
      hasRetention in interface BackupScheduleOrBuilder
      Returns:
      Whether the retention field is set.

    • getRetention

      public com.google.protobuf.Duration getRetention()
       At what relative time in the future, compared to its creation time,
 the backup should be deleted, e.g. keep backups for 7 days.

 The maximum supported retention period is 14 weeks.
      .google.protobuf.Duration retention = 6;
      Specified by:
      getRetention in interface BackupScheduleOrBuilder
      Returns:
      The retention.

    • getRetentionOrBuilder

      public com.google.protobuf.DurationOrBuilder getRetentionOrBuilder()
       At what relative time in the future, compared to its creation time,
 the backup should be deleted, e.g. keep backups for 7 days.

 The maximum supported retention period is 14 weeks.
      .google.protobuf.Duration retention = 6;
      Specified by:
      getRetentionOrBuilder in interface BackupScheduleOrBuilder

    • hasDailyRecurrence

      public boolean hasDailyRecurrence()
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;
      Specified by:
      hasDailyRecurrence in interface BackupScheduleOrBuilder
      Returns:
      Whether the dailyRecurrence field is set.

    • getDailyRecurrence

      public DailyRecurrence getDailyRecurrence()
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;
      Specified by:
      getDailyRecurrence in interface BackupScheduleOrBuilder
      Returns:
      The dailyRecurrence.

    • getDailyRecurrenceOrBuilder

      public DailyRecurrenceOrBuilder getDailyRecurrenceOrBuilder()
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;
      Specified by:
      getDailyRecurrenceOrBuilder in interface BackupScheduleOrBuilder

    • hasWeeklyRecurrence

      public boolean hasWeeklyRecurrence()
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;
      Specified by:
      hasWeeklyRecurrence in interface BackupScheduleOrBuilder
      Returns:
      Whether the weeklyRecurrence field is set.

    • getWeeklyRecurrence

      public WeeklyRecurrence getWeeklyRecurrence()
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;
      Specified by:
      getWeeklyRecurrence in interface BackupScheduleOrBuilder
      Returns:
      The weeklyRecurrence.

    • getWeeklyRecurrenceOrBuilder

      public WeeklyRecurrenceOrBuilder getWeeklyRecurrenceOrBuilder()
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;
      Specified by:
      getWeeklyRecurrenceOrBuilder in interface BackupScheduleOrBuilder

    • 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 BackupSchedule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BackupSchedule.Builder newBuilder()

    • newBuilder

      public static BackupSchedule.Builder newBuilder(BackupSchedule prototype)

    • toBuilder

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

    • newBuilderForType

      protected BackupSchedule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BackupSchedule getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<BackupSchedule> 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 BackupSchedule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder