Class BackupSchedule (6.74.0)

public final class BackupSchedule extends 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

Static Fields

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

FULL_BACKUP_SPEC_FIELD_NUMBER

public static final int FULL_BACKUP_SPEC_FIELD_NUMBER
Field Value
Type Description
int

INCREMENTAL_BACKUP_SPEC_FIELD_NUMBER

public static final int INCREMENTAL_BACKUP_SPEC_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_DURATION_FIELD_NUMBER

public static final int RETENTION_DURATION_FIELD_NUMBER
Field Value
Type Description
int

SPEC_FIELD_NUMBER

public static final int SPEC_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupSchedule getDefaultInstance()
Returns
Type Description
BackupSchedule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BackupSchedule.Builder newBuilder()
Returns
Type Description
BackupSchedule.Builder

newBuilder(BackupSchedule prototype)

public static BackupSchedule.Builder newBuilder(BackupSchedule prototype)
Parameter
Name Description
prototype BackupSchedule
Returns
Type Description
BackupSchedule.Builder

parseDelimitedFrom(InputStream input)

public static BackupSchedule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupSchedule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupSchedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BackupSchedule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackupSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackupSchedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackupSchedule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackupSchedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackupSchedule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupSchedule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupSchedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BackupSchedule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupSchedule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupSchedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BackupSchedule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackupSchedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BackupSchedule> parser()
Returns
Type Description
Parser<BackupSchedule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupTypeSpecCase()

public BackupSchedule.BackupTypeSpecCase getBackupTypeSpecCase()
Returns
Type Description
BackupSchedule.BackupTypeSpecCase

getDefaultInstanceForType()

public BackupSchedule getDefaultInstanceForType()
Returns
Type Description
BackupSchedule

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];

Returns
Type Description
CreateBackupEncryptionConfig

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];

Returns
Type Description
CreateBackupEncryptionConfigOrBuilder

getFullBackupSpec()

public FullBackupSpec getFullBackupSpec()

The schedule creates only full backups.

.google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;

Returns
Type Description
FullBackupSpec

The fullBackupSpec.

getFullBackupSpecOrBuilder()

public FullBackupSpecOrBuilder getFullBackupSpecOrBuilder()

The schedule creates only full backups.

.google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;

Returns
Type Description
FullBackupSpecOrBuilder

getIncrementalBackupSpec()

public IncrementalBackupSpec getIncrementalBackupSpec()

The schedule creates incremental backup chains.

.google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;

Returns
Type Description
IncrementalBackupSpec

The incrementalBackupSpec.

getIncrementalBackupSpecOrBuilder()

public IncrementalBackupSpecOrBuilder getIncrementalBackupSpecOrBuilder()

The schedule creates incremental backup chains.

.google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;

Returns
Type Description
IncrementalBackupSpecOrBuilder

getName()

public String getName()

Identifier. Output only for the CreateBackupSchedule operation. Required for the 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] The final segment of the name must be between 2 and 60 characters in length.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Output only for the CreateBackupSchedule operation. Required for the 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] The final segment of the name must be between 2 and 60 characters in length.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<BackupSchedule> getParserForType()
Returns
Type Description
Parser<BackupSchedule>
Overrides

getRetentionDuration()

public 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];

Returns
Type Description
Duration

The retentionDuration.

getRetentionDurationOrBuilder()

public 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];

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
BackupScheduleSpec

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];

Returns
Type Description
BackupScheduleSpecOrBuilder

getUpdateTime()

public 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];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.

hasFullBackupSpec()

public boolean hasFullBackupSpec()

The schedule creates only full backups.

.google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;

Returns
Type Description
boolean

Whether the fullBackupSpec field is set.

hasIncrementalBackupSpec()

public boolean hasIncrementalBackupSpec()

The schedule creates incremental backup chains.

.google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;

Returns
Type Description
boolean

Whether the incrementalBackupSpec field is set.

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];

Returns
Type Description
boolean

Whether the retentionDuration field is set.

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];

Returns
Type Description
boolean

Whether the spec field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BackupSchedule.Builder newBuilderForType()
Returns
Type Description
BackupSchedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackupSchedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackupSchedule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BackupSchedule.Builder toBuilder()
Returns
Type Description
BackupSchedule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException