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

Class CrontabSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.CrontabSpec
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CrontabSpecOrBuilder, Serializable
public final class CrontabSpec extends com.google.protobuf.GeneratedMessageV3 implements CrontabSpecOrBuilder
 CrontabSpec can be used to specify the version time and frequency at
 which the backup should be created.
Protobuf type google.spanner.admin.database.v1.CrontabSpec
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CrontabSpec.Builder
    CrontabSpec can be used to specify the version time and frequency at which the backup should be created.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CREATION_WINDOW_FIELD_NUMBER
     
    static final int
    TEXT_FIELD_NUMBER
     
    static final int
    TIME_ZONE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Duration
    getCreationWindow()
    Output only.
    com.google.protobuf.DurationOrBuilder
    getCreationWindowOrBuilder()
    Output only.
    static CrontabSpec
    getDefaultInstance()
     
    CrontabSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<CrontabSpec>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getText()
    Required.
    com.google.protobuf.ByteString
    getTextBytes()
    Required.
    String
    getTimeZone()
    Output only.
    com.google.protobuf.ByteString
    getTimeZoneBytes()
    Output only.
    boolean
    hasCreationWindow()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CrontabSpec.Builder
    newBuilder()
     
    static CrontabSpec.Builder
    newBuilder(CrontabSpec prototype)
     
    CrontabSpec.Builder
    newBuilderForType()
     
    protected CrontabSpec.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CrontabSpec
    parseDelimitedFrom(InputStream input)
     
    static CrontabSpec
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CrontabSpec
    parseFrom(byte[] data)
     
    static CrontabSpec
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CrontabSpec
    parseFrom(com.google.protobuf.ByteString data)
     
    static CrontabSpec
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CrontabSpec
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CrontabSpec
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CrontabSpec
    parseFrom(InputStream input)
     
    static CrontabSpec
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CrontabSpec
    parseFrom(ByteBuffer data)
     
    static CrontabSpec
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CrontabSpec>
    parser()
     
    CrontabSpec.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • TIME_ZONE_FIELD_NUMBER

      public static final int TIME_ZONE_FIELD_NUMBER
      See Also:

    • CREATION_WINDOW_FIELD_NUMBER

      public static final int CREATION_WINDOW_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getText

      public 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];
      Specified by:
      getText in interface CrontabSpecOrBuilder
      Returns:
      The text.

    • getTextBytes

      public 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];
      Specified by:
      getTextBytes in interface CrontabSpecOrBuilder
      Returns:
      The bytes for text.

    • getTimeZone

      public 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];
      Specified by:
      getTimeZone in interface CrontabSpecOrBuilder
      Returns:
      The timeZone.

    • getTimeZoneBytes

      public 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];
      Specified by:
      getTimeZoneBytes in interface CrontabSpecOrBuilder
      Returns:
      The bytes for timeZone.

    • hasCreationWindow

      public 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];
      Specified by:
      hasCreationWindow in interface CrontabSpecOrBuilder
      Returns:
      Whether the creationWindow field is set.

    • getCreationWindow

      public 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];
      Specified by:
      getCreationWindow in interface CrontabSpecOrBuilder
      Returns:
      The creationWindow.

    • getCreationWindowOrBuilder

      public 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];
      Specified by:
      getCreationWindowOrBuilder in interface CrontabSpecOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CrontabSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CrontabSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CrontabSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CrontabSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CrontabSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CrontabSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CrontabSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CrontabSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CrontabSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CrontabSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CrontabSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CrontabSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CrontabSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CrontabSpec.Builder newBuilder()

    • newBuilder

      public static CrontabSpec.Builder newBuilder(CrontabSpec prototype)

    • toBuilder

      public CrontabSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CrontabSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CrontabSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CrontabSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<CrontabSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public CrontabSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder