Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface BackupOrBuilder (0.18.0)

public interface BackupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Resource labels to represent user provided metadata. No labels currently defined.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getBackupApplianceBackupProperties()

public abstract BackupApplianceBackupProperties getBackupApplianceBackupProperties()

Output only. Backup Appliance specific backup properties.

.google.cloud.backupdr.v1.BackupApplianceBackupProperties backup_appliance_backup_properties = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BackupApplianceBackupProperties`	The backupApplianceBackupProperties.

getBackupApplianceBackupPropertiesOrBuilder()

public abstract BackupApplianceBackupPropertiesOrBuilder getBackupApplianceBackupPropertiesOrBuilder()

Output only. Backup Appliance specific backup properties.

.google.cloud.backupdr.v1.BackupApplianceBackupProperties backup_appliance_backup_properties = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BackupApplianceBackupPropertiesOrBuilder`

getBackupApplianceLocks(int index)

public abstract BackupLock getBackupApplianceLocks(int index)

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`BackupLock`

getBackupApplianceLocksCount()

public abstract int getBackupApplianceLocksCount()

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getBackupApplianceLocksList()

public abstract List<BackupLock> getBackupApplianceLocksList()

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<BackupLock>`

getBackupApplianceLocksOrBuilder(int index)

public abstract BackupLockOrBuilder getBackupApplianceLocksOrBuilder(int index)

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`BackupLockOrBuilder`

getBackupApplianceLocksOrBuilderList()

public abstract List<? extends BackupLockOrBuilder> getBackupApplianceLocksOrBuilderList()

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.backupdr.v1.BackupLockOrBuilder>`

getBackupPropertiesCase()

public abstract Backup.BackupPropertiesCase getBackupPropertiesCase()

Returns
Type	Description
`Backup.BackupPropertiesCase`

getBackupType()

public abstract Backup.BackupType getBackupType()

Output only. Type of the backup, unspecified, scheduled or ondemand.

.google.cloud.backupdr.v1.Backup.BackupType backup_type = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Backup.BackupType`	The backupType.

getBackupTypeValue()

public abstract int getBackupTypeValue()

Output only. Type of the backup, unspecified, scheduled or ondemand.

.google.cloud.backupdr.v1.Backup.BackupType backup_type = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for backupType.

getComputeInstanceBackupProperties()

public abstract ComputeInstanceBackupProperties getComputeInstanceBackupProperties()

Output only. Compute Engine specific backup properties.

.google.cloud.backupdr.v1.ComputeInstanceBackupProperties compute_instance_backup_properties = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ComputeInstanceBackupProperties`	The computeInstanceBackupProperties.

getComputeInstanceBackupPropertiesOrBuilder()

public abstract ComputeInstanceBackupPropertiesOrBuilder getComputeInstanceBackupPropertiesOrBuilder()

Output only. Compute Engine specific backup properties.

.google.cloud.backupdr.v1.ComputeInstanceBackupProperties compute_instance_backup_properties = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ComputeInstanceBackupPropertiesOrBuilder`

getConsistencyTime()

public abstract Timestamp getConsistencyTime()

Output only. The point in time when this backup was captured from the source.

optional .google.protobuf.Timestamp consistency_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The consistencyTime.

getConsistencyTimeOrBuilder()

public abstract TimestampOrBuilder getConsistencyTimeOrBuilder()

Output only. The point in time when this backup was captured from the source.

optional .google.protobuf.Timestamp consistency_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time when the instance was created.

optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the instance was created.

optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDescription()

public abstract String getDescription()

Output only. The description of the Backup instance (2048 characters or less).

optional string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Output only. The description of the Backup instance (2048 characters or less).

optional string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for description.

getEnforcedRetentionEndTime()

public abstract Timestamp getEnforcedRetentionEndTime()

Optional. The backup can not be deleted before this time.

optional .google.protobuf.Timestamp enforced_retention_end_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Timestamp`	The enforcedRetentionEndTime.

getEnforcedRetentionEndTimeOrBuilder()

public abstract TimestampOrBuilder getEnforcedRetentionEndTimeOrBuilder()

Optional. The backup can not be deleted before this time.

optional .google.protobuf.Timestamp enforced_retention_end_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TimestampOrBuilder`

getEtag()

public abstract String getEtag()

Optional. Server specified ETag to prevent updates from overwriting each other.

optional string etag = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Optional. Server specified ETag to prevent updates from overwriting each other.

optional string etag = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for etag.

getExpireTime()

public abstract Timestamp getExpireTime()

Optional. When this backup is automatically expired.

optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Timestamp`	The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Optional. When this backup is automatically expired.

optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TimestampOrBuilder`

getGcpBackupPlanInfo()

public abstract Backup.GCPBackupPlanInfo getGcpBackupPlanInfo()

Output only. Configuration for a Google Cloud resource.

.google.cloud.backupdr.v1.Backup.GCPBackupPlanInfo gcp_backup_plan_info = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Backup.GCPBackupPlanInfo`	The gcpBackupPlanInfo.

getGcpBackupPlanInfoOrBuilder()

public abstract Backup.GCPBackupPlanInfoOrBuilder getGcpBackupPlanInfoOrBuilder()

Output only. Configuration for a Google Cloud resource.

.google.cloud.backupdr.v1.Backup.GCPBackupPlanInfo gcp_backup_plan_info = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Backup.GCPBackupPlanInfoOrBuilder`

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

Optional. Resource labels to represent user provided metadata. No labels currently defined.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Resource labels to represent user provided metadata. No labels currently defined.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Resource labels to represent user provided metadata. No labels currently defined.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Resource labels to represent user provided metadata. No labels currently defined.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract String getName()

Output only. Identifier. Name of the backup to create. It must have the format"projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}". {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Identifier. Name of the backup to create. It must have the format"projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}". {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

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

Returns
Type	Description
`ByteString`	The bytes for name.

getPlanInfoCase()

public abstract Backup.PlanInfoCase getPlanInfoCase()

Returns
Type	Description
`Backup.PlanInfoCase`

getResourceSizeBytes()

public abstract long getResourceSizeBytes()

Output only. source resource size in bytes at the time of the backup.

int64 resource_size_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The resourceSizeBytes.

getServiceLocks(int index)

public abstract BackupLock getServiceLocks(int index)

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`BackupLock`

getServiceLocksCount()

public abstract int getServiceLocksCount()

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

getServiceLocksList()

public abstract List<BackupLock> getServiceLocksList()

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<BackupLock>`

getServiceLocksOrBuilder(int index)

public abstract BackupLockOrBuilder getServiceLocksOrBuilder(int index)

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`BackupLockOrBuilder`

getServiceLocksOrBuilderList()

public abstract List<? extends BackupLockOrBuilder> getServiceLocksOrBuilderList()

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<? extends com.google.cloud.backupdr.v1.BackupLockOrBuilder>`

getState()

public abstract Backup.State getState()

Output only. The Backup resource instance state.

.google.cloud.backupdr.v1.Backup.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Backup.State`	The state.

getStateValue()

public abstract int getStateValue()

Output only. The Backup resource instance state.

.google.cloud.backupdr.v1.Backup.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time when the instance was updated.

optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the instance was updated.

optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

hasBackupApplianceBackupProperties()

public abstract boolean hasBackupApplianceBackupProperties()

Output only. Backup Appliance specific backup properties.

.google.cloud.backupdr.v1.BackupApplianceBackupProperties backup_appliance_backup_properties = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the backupApplianceBackupProperties field is set.

hasComputeInstanceBackupProperties()

public abstract boolean hasComputeInstanceBackupProperties()

Output only. Compute Engine specific backup properties.

.google.cloud.backupdr.v1.ComputeInstanceBackupProperties compute_instance_backup_properties = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the computeInstanceBackupProperties field is set.

hasConsistencyTime()

public abstract boolean hasConsistencyTime()

Output only. The point in time when this backup was captured from the source.

optional .google.protobuf.Timestamp consistency_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the consistencyTime field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time when the instance was created.

optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasDescription()

public abstract boolean hasDescription()

Output only. The description of the Backup instance (2048 characters or less).

optional string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the description field is set.

hasEnforcedRetentionEndTime()

public abstract boolean hasEnforcedRetentionEndTime()

Optional. The backup can not be deleted before this time.

optional .google.protobuf.Timestamp enforced_retention_end_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the enforcedRetentionEndTime field is set.

hasEtag()

public abstract boolean hasEtag()

Optional. Server specified ETag to prevent updates from overwriting each other.

optional string etag = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the etag field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

Optional. When this backup is automatically expired.

optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the expireTime field is set.

hasGcpBackupPlanInfo()

public abstract boolean hasGcpBackupPlanInfo()

Output only. Configuration for a Google Cloud resource.

.google.cloud.backupdr.v1.Backup.GCPBackupPlanInfo gcp_backup_plan_info = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the gcpBackupPlanInfo field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time when the instance was updated.

optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-28 UTC.