Class: Google::Apis::SpannerV1::CrontabSpec

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

Overview

CrontabSpec can be used to specify the version time and frequency at which the backup should be created.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CrontabSpec

Returns a new instance of CrontabSpec.



1995
1996
1997
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1995

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

Instance Attribute Details

#creation_window ⇒ String

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec. cron_spec and version_time + creation_window. Corresponds to the JSON property creationWindow

Returns:

  • (String) 


1973
1974
1975
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1973

def creation_window
  @creation_window
end

#text ⇒ String

Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * 0 2/12 * * * : every 12 hours at (2, 14) hours past midnight in UTC. * 0 2,14 * * * : every 12 hours at (2,14) hours past midnight in UTC. * 0 2 * * * : once a day at 2 past midnight in UTC. * 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC. * 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC. Corresponds to the JSON property text

Returns:

  • (String) 


1987
1988
1989
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1987

def text
  @text
end

#time_zone ⇒ String

Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported. Corresponds to the JSON property timeZone

Returns:

  • (String) 


1993
1994
1995
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1993

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2000
2001
2002
2003
2004
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2000

def update!(**args)
  @creation_window = args[:creation_window] if args.key?(:creation_window)
  @text = args[:text] if args.key?(:text)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end