Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.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 Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1BackupSchedule

Returns a new instance of GoogleFirestoreAdminV1BackupSchedule.



1058
1059
1060
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1058

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

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. Corresponds to the JSON property createTime

Returns:

  • (String) 


1024
1025
1026
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1024

def create_time
  @create_time
end

#daily_recurrence ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DailyRecurrence

Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. Corresponds to the JSON property dailyRecurrence

Returns:



1030
1031
1032
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1030

def daily_recurrence
  @daily_recurrence
end

#name ⇒ 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` Corresponds to the JSON propertyname`

Returns:

  • (String) 


1037
1038
1039
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1037

def name
  @name
end

#retention ⇒ String

At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days. Corresponds to the JSON property retention

Returns:

  • (String) 


1043
1044
1045
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1043

def retention
  @retention
end

#update_time ⇒ String

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. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1050
1051
1052
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1050

def update_time
  @update_time
end

#weekly_recurrence ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1WeeklyRecurrence

Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. Corresponds to the JSON property weeklyRecurrence

Returns:



1056
1057
1058
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1056

def weekly_recurrence
  @weekly_recurrence
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1063

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @daily_recurrence = args[:daily_recurrence] if args.key?(:daily_recurrence)
  @name = args[:name] if args.key?(:name)
  @retention = args[:retention] if args.key?(:retention)
  @update_time = args[:update_time] if args.key?(:update_time)
  @weekly_recurrence = args[:weekly_recurrence] if args.key?(:weekly_recurrence)
end