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.



1263
1264
1265
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1263

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) 


1229
1230
1231
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1229

def create_time
  @create_time
end

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

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

Returns:



1234
1235
1236
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1234

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) 


1241
1242
1243
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1241

def name
  @name
end

#retention ⇒ String

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

Returns:

  • (String) 


1248
1249
1250
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1248

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) 


1255
1256
1257
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1255

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:



1261
1262
1263
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1261

def weekly_recurrence
  @weekly_recurrence
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1268

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