Package com.google.spanner.admin.database.v1

Interface CrontabSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CrontabSpec, CrontabSpec.Builder
public interface CrontabSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getCreationWindow()
    Output only.
    com.google.protobuf.DurationOrBuilder
    getCreationWindowOrBuilder()
    Output only.
    String
    getText()
    Required.
    com.google.protobuf.ByteString
    getTextBytes()
    Required.
    String
    getTimeZone()
    Output only.
    com.google.protobuf.ByteString
    getTimeZoneBytes()
    Output only.
    boolean
    hasCreationWindow()
    Output only.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getText

      String getText()
       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.
      string text = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The text.

    • getTextBytes

      com.google.protobuf.ByteString getTextBytes()
       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.
      string text = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for text.

    • getTimeZone

      String getTimeZone()
       Output only. The time zone of the times in `CrontabSpec.text`. Currently
 only UTC is supported.
      string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The timeZone.

    • getTimeZoneBytes

      com.google.protobuf.ByteString getTimeZoneBytes()
       Output only. The time zone of the times in `CrontabSpec.text`. Currently
 only UTC is supported.
      string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for timeZone.

    • hasCreationWindow

      boolean hasCreationWindow()
       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`.
      .google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the creationWindow field is set.

    • getCreationWindow

      com.google.protobuf.Duration getCreationWindow()
       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`.
      .google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The creationWindow.

    • getCreationWindowOrBuilder

      com.google.protobuf.DurationOrBuilder getCreationWindowOrBuilder()
       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`.
      .google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];