Package com.google.firestore.admin.v1
Interface BackupScheduleOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
BackupSchedule,BackupSchedule.Builder
@Generated
public interface BackupScheduleOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptioncom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.For a schedule that runs daily.For a schedule that runs daily.getName()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.DurationAt 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.DurationOrBuilderAt 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.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.For a schedule that runs weekly on a specific day.For a schedule that runs weekly on a specific day.booleanOutput only.booleanFor a schedule that runs daily.booleanAt what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.booleanOutput only.booleanFor a schedule that runs weekly on a specific day.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
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];- Returns:
- The name.
-
getNameBytes
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];- Returns:
- The bytes for name.
-
hasCreateTime
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];- Returns:
- Whether the createTime field is set.
-
getCreateTime
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];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
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]; -
hasUpdateTime
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];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
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];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
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]; -
hasRetention
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;- Returns:
- Whether the retention field is set.
-
getRetention
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;- Returns:
- The retention.
-
getRetentionOrBuilder
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; -
hasDailyRecurrence
boolean hasDailyRecurrence()For a schedule that runs daily.
.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;- Returns:
- Whether the dailyRecurrence field is set.
-
getDailyRecurrence
DailyRecurrence getDailyRecurrence()For a schedule that runs daily.
.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;- Returns:
- The dailyRecurrence.
-
getDailyRecurrenceOrBuilder
DailyRecurrenceOrBuilder getDailyRecurrenceOrBuilder()For a schedule that runs daily.
.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7; -
hasWeeklyRecurrence
boolean hasWeeklyRecurrence()For a schedule that runs weekly on a specific day.
.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;- Returns:
- Whether the weeklyRecurrence field is set.
-
getWeeklyRecurrence
WeeklyRecurrence getWeeklyRecurrence()For a schedule that runs weekly on a specific day.
.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;- Returns:
- The weeklyRecurrence.
-
getWeeklyRecurrenceOrBuilder
WeeklyRecurrenceOrBuilder getWeeklyRecurrenceOrBuilder()For a schedule that runs weekly on a specific day.
.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8; -
getRecurrenceCase
BackupSchedule.RecurrenceCase getRecurrenceCase()
-