Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::BackupSchedule.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — 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.
#daily_recurrence
def daily_recurrence() -> ::Google::Cloud::Firestore::Admin::V1::DailyRecurrence-
(::Google::Cloud::Firestore::Admin::V1::DailyRecurrence) — For a schedule that runs daily.
Note: The following fields are mutually exclusive:
daily_recurrence,weekly_recurrence. If a field in that set is populated, all other fields in the set will automatically be cleared.
#daily_recurrence=
def daily_recurrence=(value) -> ::Google::Cloud::Firestore::Admin::V1::DailyRecurrence-
value (::Google::Cloud::Firestore::Admin::V1::DailyRecurrence) — For a schedule that runs daily.
Note: The following fields are mutually exclusive:
daily_recurrence,weekly_recurrence. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Firestore::Admin::V1::DailyRecurrence) — For a schedule that runs daily.
Note: The following fields are mutually exclusive:
daily_recurrence,weekly_recurrence. If a field in that set is populated, all other fields in the set will automatically be cleared.
#name
def name() -> ::String-
(::String) — 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}
#retention
def retention() -> ::Google::Protobuf::Duration-
(::Google::Protobuf::Duration) — 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.
#retention=
def retention=(value) -> ::Google::Protobuf::Duration-
value (::Google::Protobuf::Duration) — 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) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — 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.
#weekly_recurrence
def weekly_recurrence() -> ::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence-
(::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence) — For a schedule that runs weekly on a specific day.
Note: The following fields are mutually exclusive:
weekly_recurrence,daily_recurrence. If a field in that set is populated, all other fields in the set will automatically be cleared.
#weekly_recurrence=
def weekly_recurrence=(value) -> ::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence-
value (::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence) — For a schedule that runs weekly on a specific day.
Note: The following fields are mutually exclusive:
weekly_recurrence,daily_recurrence. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence) — For a schedule that runs weekly on a specific day.
Note: The following fields are mutually exclusive:
weekly_recurrence,daily_recurrence. If a field in that set is populated, all other fields in the set will automatically be cleared.