Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::CrontabSpec (v1.0.0)

Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::CrontabSpec.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#creation_window

def creation_window() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#text

def text() -> ::String
Returns
  • (::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.

#text=

def text=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#time_zone

def time_zone() -> ::String
Returns
  • (::String) — Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported.