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

Class BackupSchedule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.BackupSchedule
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BackupScheduleOrBuilder, Serializable
public final class BackupSchedule extends com.google.protobuf.GeneratedMessageV3 implements BackupScheduleOrBuilder
 BackupSchedule expresses the automated backup creation specification for a
 Spanner database.
 Next ID: 10
Protobuf type google.spanner.admin.database.v1.BackupSchedule
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SPEC_FIELD_NUMBER

      public static final int SPEC_FIELD_NUMBER
      See Also:

    • RETENTION_DURATION_FIELD_NUMBER

      public static final int RETENTION_DURATION_FIELD_NUMBER
      See Also:

    • ENCRYPTION_CONFIG_FIELD_NUMBER

      public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
      See Also:

    • FULL_BACKUP_SPEC_FIELD_NUMBER

      public static final int FULL_BACKUP_SPEC_FIELD_NUMBER
      See Also:

    • INCREMENTAL_BACKUP_SPEC_FIELD_NUMBER

      public static final int INCREMENTAL_BACKUP_SPEC_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_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

    • getBackupTypeSpecCase

      public BackupSchedule.BackupTypeSpecCase getBackupTypeSpecCase()
      Specified by:
      getBackupTypeSpecCase in interface BackupScheduleOrBuilder

    • getName

      public String getName()
       Identifier. Output only for the
 [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation.
 Required for the
 [UpdateBackupSchedule][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule]
 operation. A globally unique identifier for the backup schedule which
 cannot be changed. Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]`
 The final segment of the name must be between 2 and 60 characters in
 length.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface BackupScheduleOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Output only for the
 [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation.
 Required for the
 [UpdateBackupSchedule][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule]
 operation. A globally unique identifier for the backup schedule which
 cannot be changed. Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]`
 The final segment of the name must be between 2 and 60 characters in
 length.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface BackupScheduleOrBuilder
      Returns:
      The bytes for name.

    • hasSpec

      public boolean hasSpec()
       Optional. The schedule specification based on which the backup creations
 are triggered.
      .google.spanner.admin.database.v1.BackupScheduleSpec spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSpec in interface BackupScheduleOrBuilder
      Returns:
      Whether the spec field is set.

    • getSpec

      public BackupScheduleSpec getSpec()
       Optional. The schedule specification based on which the backup creations
 are triggered.
      .google.spanner.admin.database.v1.BackupScheduleSpec spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSpec in interface BackupScheduleOrBuilder
      Returns:
      The spec.

    • getSpecOrBuilder

      public BackupScheduleSpecOrBuilder getSpecOrBuilder()
       Optional. The schedule specification based on which the backup creations
 are triggered.
      .google.spanner.admin.database.v1.BackupScheduleSpec spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSpecOrBuilder in interface BackupScheduleOrBuilder

    • hasRetentionDuration

      public boolean hasRetentionDuration()
       Optional. The retention duration of a backup that must be at least 6 hours
 and at most 366 days. The backup is eligible to be automatically deleted
 once the retention period has elapsed.
      .google.protobuf.Duration retention_duration = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRetentionDuration in interface BackupScheduleOrBuilder
      Returns:
      Whether the retentionDuration field is set.

    • getRetentionDuration

      public com.google.protobuf.Duration getRetentionDuration()
       Optional. The retention duration of a backup that must be at least 6 hours
 and at most 366 days. The backup is eligible to be automatically deleted
 once the retention period has elapsed.
      .google.protobuf.Duration retention_duration = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionDuration in interface BackupScheduleOrBuilder
      Returns:
      The retentionDuration.

    • getRetentionDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getRetentionDurationOrBuilder()
       Optional. The retention duration of a backup that must be at least 6 hours
 and at most 366 days. The backup is eligible to be automatically deleted
 once the retention period has elapsed.
      .google.protobuf.Duration retention_duration = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionDurationOrBuilder in interface BackupScheduleOrBuilder

    • hasEncryptionConfig

      public boolean hasEncryptionConfig()
       Optional. The encryption configuration that will be used to encrypt the
 backup. If this field is not specified, the backup will use the same
 encryption configuration as the database.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEncryptionConfig in interface BackupScheduleOrBuilder
      Returns:
      Whether the encryptionConfig field is set.

    • getEncryptionConfig

      public CreateBackupEncryptionConfig getEncryptionConfig()
       Optional. The encryption configuration that will be used to encrypt the
 backup. If this field is not specified, the backup will use the same
 encryption configuration as the database.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionConfig in interface BackupScheduleOrBuilder
      Returns:
      The encryptionConfig.

    • getEncryptionConfigOrBuilder

      public CreateBackupEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
       Optional. The encryption configuration that will be used to encrypt the
 backup. If this field is not specified, the backup will use the same
 encryption configuration as the database.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionConfigOrBuilder in interface BackupScheduleOrBuilder

    • hasFullBackupSpec

      public boolean hasFullBackupSpec()
       The schedule creates only full backups.
      .google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
      Specified by:
      hasFullBackupSpec in interface BackupScheduleOrBuilder
      Returns:
      Whether the fullBackupSpec field is set.

    • getFullBackupSpec

      public FullBackupSpec getFullBackupSpec()
       The schedule creates only full backups.
      .google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
      Specified by:
      getFullBackupSpec in interface BackupScheduleOrBuilder
      Returns:
      The fullBackupSpec.

    • getFullBackupSpecOrBuilder

      public FullBackupSpecOrBuilder getFullBackupSpecOrBuilder()
       The schedule creates only full backups.
      .google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
      Specified by:
      getFullBackupSpecOrBuilder in interface BackupScheduleOrBuilder

    • hasIncrementalBackupSpec

      public boolean hasIncrementalBackupSpec()
       The schedule creates incremental backup chains.
      .google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
      Specified by:
      hasIncrementalBackupSpec in interface BackupScheduleOrBuilder
      Returns:
      Whether the incrementalBackupSpec field is set.

    • getIncrementalBackupSpec

      public IncrementalBackupSpec getIncrementalBackupSpec()
       The schedule creates incremental backup chains.
      .google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
      Specified by:
      getIncrementalBackupSpec in interface BackupScheduleOrBuilder
      Returns:
      The incrementalBackupSpec.

    • getIncrementalBackupSpecOrBuilder

      public IncrementalBackupSpecOrBuilder getIncrementalBackupSpecOrBuilder()
       The schedule creates incremental backup chains.
      .google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
      Specified by:
      getIncrementalBackupSpecOrBuilder in interface BackupScheduleOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The timestamp at which the schedule was last updated.
 If the schedule has never been updated, this field contains the timestamp
 when the schedule was first created.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface BackupScheduleOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp at which the schedule was last updated.
 If the schedule has never been updated, this field contains the timestamp
 when the schedule was first created.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface BackupScheduleOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp at which the schedule was last updated.
 If the schedule has never been updated, this field contains the timestamp
 when the schedule was first created.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface BackupScheduleOrBuilder

    • 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 BackupSchedule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BackupSchedule.Builder newBuilder()

    • newBuilder

      public static BackupSchedule.Builder newBuilder(BackupSchedule prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BackupSchedule getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<BackupSchedule> 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 BackupSchedule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder