Package com.google.firestore.admin.v1

Class BackupSchedule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BackupSchedule.Builder>
com.google.firestore.admin.v1.BackupSchedule.Builder
All Implemented Interfaces:
BackupScheduleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BackupSchedule
public static final class BackupSchedule.Builder extends com.google.protobuf.GeneratedMessage.Builder<BackupSchedule.Builder> 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

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

    • clear

      public BackupSchedule.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<BackupSchedule.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<BackupSchedule.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public BackupSchedule.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<BackupSchedule.Builder>

    • mergeFrom

      public BackupSchedule.Builder mergeFrom(BackupSchedule other)

    • isInitialized

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

    • mergeFrom

      public BackupSchedule.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<BackupSchedule.Builder>
      Throws:
      IOException

    • getRecurrenceCase

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

    • clearRecurrence

      public BackupSchedule.Builder clearRecurrence()

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

    • setName

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

    • clearName

      public BackupSchedule.Builder clearName()
       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];
      Returns:
      This builder for chaining.

    • setNameBytes

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

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

    • setCreateTime

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

    • setCreateTime

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

    • mergeCreateTime

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

    • clearCreateTime

      public BackupSchedule.Builder clearCreateTime()
       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];

    • getCreateTimeBuilder

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

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

    • setUpdateTime

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

    • setUpdateTime

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

    • mergeUpdateTime

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

    • clearUpdateTime

      public BackupSchedule.Builder clearUpdateTime()
       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];

    • getUpdateTimeBuilder

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

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

    • setRetention

      public BackupSchedule.Builder setRetention(com.google.protobuf.Duration value)
       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;

    • setRetention

      public BackupSchedule.Builder setRetention(com.google.protobuf.Duration.Builder builderForValue)
       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;

    • mergeRetention

      public BackupSchedule.Builder mergeRetention(com.google.protobuf.Duration value)
       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;

    • clearRetention

      public BackupSchedule.Builder clearRetention()
       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;

    • getRetentionBuilder

      public com.google.protobuf.Duration.Builder getRetentionBuilder()
       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;

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

    • setDailyRecurrence

      public BackupSchedule.Builder setDailyRecurrence(DailyRecurrence value)
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

    • setDailyRecurrence

      public BackupSchedule.Builder setDailyRecurrence(DailyRecurrence.Builder builderForValue)
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

    • mergeDailyRecurrence

      public BackupSchedule.Builder mergeDailyRecurrence(DailyRecurrence value)
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

    • clearDailyRecurrence

      public BackupSchedule.Builder clearDailyRecurrence()
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

    • getDailyRecurrenceBuilder

      public DailyRecurrence.Builder getDailyRecurrenceBuilder()
       For a schedule that runs daily.
      .google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

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

    • setWeeklyRecurrence

      public BackupSchedule.Builder setWeeklyRecurrence(WeeklyRecurrence value)
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

    • setWeeklyRecurrence

      public BackupSchedule.Builder setWeeklyRecurrence(WeeklyRecurrence.Builder builderForValue)
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

    • mergeWeeklyRecurrence

      public BackupSchedule.Builder mergeWeeklyRecurrence(WeeklyRecurrence value)
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

    • clearWeeklyRecurrence

      public BackupSchedule.Builder clearWeeklyRecurrence()
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

    • getWeeklyRecurrenceBuilder

      public WeeklyRecurrence.Builder getWeeklyRecurrenceBuilder()
       For a schedule that runs weekly on a specific day.
      .google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

    • 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