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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BackupSchedule.Builder newBuilder()
newBuilder(BackupSchedule prototype)
public static BackupSchedule.Builder newBuilder(BackupSchedule prototype)
public static BackupSchedule parseDelimitedFrom(InputStream input)
public static BackupSchedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BackupSchedule parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BackupSchedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BackupSchedule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackupSchedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackupSchedule parseFrom(CodedInputStream input)
public static BackupSchedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BackupSchedule parseFrom(InputStream input)
public static BackupSchedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BackupSchedule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BackupSchedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BackupSchedule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackupTypeSpecCase()
public BackupSchedule.BackupTypeSpecCase getBackupTypeSpecCase()
getDefaultInstanceForType()
public BackupSchedule getDefaultInstanceForType()
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];
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];
getFullBackupSpec()
public FullBackupSpec getFullBackupSpec()
The schedule creates only full backups.
.google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
getFullBackupSpecOrBuilder()
public FullBackupSpecOrBuilder getFullBackupSpecOrBuilder()
The schedule creates only full backups.
.google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
getIncrementalBackupSpec()
public IncrementalBackupSpec getIncrementalBackupSpec()
The schedule creates incremental backup chains.
.google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
getIncrementalBackupSpecOrBuilder()
public IncrementalBackupSpecOrBuilder getIncrementalBackupSpecOrBuilder()
The schedule creates incremental backup chains.
.google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
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()
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];
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];
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];
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];
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BackupSchedule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BackupSchedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BackupSchedule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
