Class: Google::Cloud::Firestore::Admin::V1::BackupSchedule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/admin/v1/schedule.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:

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



61
62
63
64
 
# File 'proto_docs/google/firestore/admin/v1/schedule.rb', line 61

class BackupSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#daily_recurrence ⇒ ::Google::Cloud::Firestore::Admin::V1::DailyRecurrence

Returns For a schedule that runs daily.

Returns:



61
62
63
64
 
# File 'proto_docs/google/firestore/admin/v1/schedule.rb', line 61

class BackupSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns 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}.

Returns:

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



61
62
63
64
 
# File 'proto_docs/google/firestore/admin/v1/schedule.rb', line 61

class BackupSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#retention ⇒ ::Google::Protobuf::Duration

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

Returns:

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



61
62
63
64
 
# File 'proto_docs/google/firestore/admin/v1/schedule.rb', line 61

class BackupSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:

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



61
62
63
64
 
# File 'proto_docs/google/firestore/admin/v1/schedule.rb', line 61

class BackupSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#weekly_recurrence ⇒ ::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence

Returns For a schedule that runs weekly on a specific day.

Returns:



61
62
63
64
 
# File 'proto_docs/google/firestore/admin/v1/schedule.rb', line 61

class BackupSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end