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.



1842
1843
1844
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1842

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) 


1808
1809
1810
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1808

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) 


1815
1816
1817
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1815

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) 


1821
1822
1823
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1821

def enabled
  @enabled
end

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

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

Returns:



1827
1828
1829
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1827

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) 


1832
1833
1834
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1832

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) 


1840
1841
1842
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1840

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1847
1848
1849
1850
1851
1852
1853
1854
 
# File 'lib/google/apis/metastore_v1/classes.rb', line 1847

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