Class: Google::Apis::MetastoreV1::ScheduledBackup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/metastore_v1/classes.rb,
lib/google/apis/metastore_v1/representations.rb,
lib/google/apis/metastore_v1/representations.rb

Overview

This specifies the configuration of scheduled backup.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ScheduledBackup

Returns a new instance of ScheduledBackup.



2233
2234
2235
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2233

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

Instance Attribute Details

#backup_location ⇒ String

Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it. Corresponds to the JSON property backupLocation

Returns:

  • (String) 


2199
2200
2201
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2199

def backup_location
  @backup_location
end

#cron_schedule ⇒ String

Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/ wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups. Corresponds to the JSON property cronSchedule

Returns:

  • (String) 


2206
2207
2208
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2206

def cron_schedule
  @cron_schedule
end

#enabled ⇒ Boolean Also known as: enabled?

Optional. Defines whether the scheduled backup is enabled. The default value is false. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


2212
2213
2214
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2212

def enabled
  @enabled
end

#latest_backup ⇒ Google::Apis::MetastoreV1::LatestBackup

The details of the latest scheduled backup. Corresponds to the JSON property latestBackup

Returns:



2218
2219
2220
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2218

def latest_backup
  @latest_backup
end

#next_scheduled_time ⇒ String

Output only. The time when the next backups execution is scheduled to start. Corresponds to the JSON property nextScheduledTime

Returns:

  • (String) 


2223
2224
2225
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2223

def next_scheduled_time
  @next_scheduled_time
end

#time_zone ⇒ String

Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/ wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/ Abidjan. If left unspecified, the default is UTC. Corresponds to the JSON property timeZone

Returns:

  • (String) 


2231
2232
2233
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2231

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2238
2239
2240
2241
2242
2243
2244
2245
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 2238

def update!(**args)
  @backup_location = args[:backup_location] if args.key?(:backup_location)
  @cron_schedule = args[:cron_schedule] if args.key?(:cron_schedule)
  @enabled = args[:enabled] if args.key?(:enabled)
  @latest_backup = args[:latest_backup] if args.key?(:latest_backup)
  @next_scheduled_time = args[:next_scheduled_time] if args.key?(:next_scheduled_time)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end