Interface BackupScheduleOrBuilder (3.28.0)

Version latest

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface BackupScheduleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract 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
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract 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];

Returns
Type	Description
TimestampOrBuilder

getDailyRecurrence()

public abstract DailyRecurrence getDailyRecurrence()

For a schedule that runs daily.

.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

Returns
Type	Description
DailyRecurrence	The dailyRecurrence.

getDailyRecurrenceOrBuilder()

public abstract DailyRecurrenceOrBuilder getDailyRecurrenceOrBuilder()

For a schedule that runs daily.

.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

Returns
Type	Description
DailyRecurrenceOrBuilder

getName()

public abstract 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
Type	Description
String	The name.

getNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for name.

getRecurrenceCase()

public abstract BackupSchedule.RecurrenceCase getRecurrenceCase()

Returns
Type	Description
BackupSchedule.RecurrenceCase

getRetention()

public abstract 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
Type	Description
Duration	The retention.

getRetentionOrBuilder()

public abstract 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;

Returns
Type	Description
DurationOrBuilder

getUpdateTime()

public abstract 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
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract 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];

Returns
Type	Description
TimestampOrBuilder

getWeeklyRecurrence()

public abstract WeeklyRecurrence getWeeklyRecurrence()

For a schedule that runs weekly on a specific day.

.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

Returns
Type	Description
WeeklyRecurrence	The weeklyRecurrence.

getWeeklyRecurrenceOrBuilder()

public abstract WeeklyRecurrenceOrBuilder getWeeklyRecurrenceOrBuilder()

For a schedule that runs weekly on a specific day.

.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

Returns
Type	Description
WeeklyRecurrenceOrBuilder

hasCreateTime()

public abstract 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
Type	Description
boolean	Whether the createTime field is set.

hasDailyRecurrence()

public abstract boolean hasDailyRecurrence()

For a schedule that runs daily.

.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

Returns
Type	Description
boolean	Whether the dailyRecurrence field is set.

hasRetention()

public abstract 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
Type	Description
boolean	Whether the retention field is set.

hasUpdateTime()

public abstract 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
Type	Description
boolean	Whether the updateTime field is set.

hasWeeklyRecurrence()

public abstract boolean hasWeeklyRecurrence()

For a schedule that runs weekly on a specific day.

.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

Returns
Type	Description
boolean	Whether the weeklyRecurrence field is set.