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

Inherits:

Object

• Object
• Google::Apis::SpannerV1::CrontabSpec

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 is created.

Instance Attribute Summary

• #creation_window ⇒ String

  Output only.

• #text ⇒ String

  Required.

• #time_zone ⇒ String

  Output only.

Instance Method Summary

• #initialize(**args) ⇒ CrontabSpec constructor

  A new instance of CrontabSpec.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ CrontabSpec

Returns a new instance of CrontabSpec.

# File 'lib/google/apis/spanner_v1/classes.rb', line 2064

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

Instance Attribute Details

#creation_window ⇒ String

Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates 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)

# File 'lib/google/apis/spanner_v1/classes.rb', line 2040

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 timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. 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 */4 * * * : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) 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)

# File 'lib/google/apis/spanner_v1/classes.rb', line 2056

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)

# File 'lib/google/apis/spanner_v1/classes.rb', line 2062

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/spanner_v1/classes.rb', line 2069

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