Interface BackupOrBuilder (0.39.0)

publicinterface BackupOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

publicabstractbooleancontainsLabels(Stringkey)

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()

publicabstractBackupApplianceBackupPropertiesgetBackupApplianceBackupProperties()

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()

publicabstractBackupApplianceBackupPropertiesOrBuildergetBackupApplianceBackupPropertiesOrBuilder()

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)

publicabstractBackupLockgetBackupApplianceLocks(intindex)

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()

publicabstractintgetBackupApplianceLocksCount()

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()

publicabstractList<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)

publicabstractBackupLockOrBuildergetBackupApplianceLocksOrBuilder(intindex)

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()

publicabstractList<?extendsBackupLockOrBuilder>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()

publicabstractBackup.BackupPropertiesCasegetBackupPropertiesCase()
Returns
Type Description
Backup.BackupPropertiesCase

getBackupType()

publicabstractBackup.BackupTypegetBackupType()

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()

publicabstractintgetBackupTypeValue()

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.

getCloudSqlInstanceBackupProperties()

publicabstractCloudSqlInstanceBackupPropertiesgetCloudSqlInstanceBackupProperties()

Output only. Cloud SQL specific backup properties.

.google.cloud.backupdr.v1.CloudSqlInstanceBackupProperties cloud_sql_instance_backup_properties = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CloudSqlInstanceBackupProperties

The cloudSqlInstanceBackupProperties.

getCloudSqlInstanceBackupPropertiesOrBuilder()

publicabstractCloudSqlInstanceBackupPropertiesOrBuildergetCloudSqlInstanceBackupPropertiesOrBuilder()

Output only. Cloud SQL specific backup properties.

.google.cloud.backupdr.v1.CloudSqlInstanceBackupProperties cloud_sql_instance_backup_properties = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CloudSqlInstanceBackupPropertiesOrBuilder

getComputeInstanceBackupProperties()

publicabstractComputeInstanceBackupPropertiesgetComputeInstanceBackupProperties()

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()

publicabstractComputeInstanceBackupPropertiesOrBuildergetComputeInstanceBackupPropertiesOrBuilder()

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()

publicabstractTimestampgetConsistencyTime()

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()

publicabstractTimestampOrBuildergetConsistencyTimeOrBuilder()

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()

publicabstractTimestampgetCreateTime()

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()

publicabstractTimestampOrBuildergetCreateTimeOrBuilder()

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()

publicabstractStringgetDescription()

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()

publicabstractByteStringgetDescriptionBytes()

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.

getDiskBackupProperties()

publicabstractDiskBackupPropertiesgetDiskBackupProperties()

Output only. Disk specific backup properties.

.google.cloud.backupdr.v1.DiskBackupProperties disk_backup_properties = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DiskBackupProperties

The diskBackupProperties.

getDiskBackupPropertiesOrBuilder()

publicabstractDiskBackupPropertiesOrBuildergetDiskBackupPropertiesOrBuilder()

Output only. Disk specific backup properties.

.google.cloud.backupdr.v1.DiskBackupProperties disk_backup_properties = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DiskBackupPropertiesOrBuilder

getEnforcedRetentionEndTime()

publicabstractTimestampgetEnforcedRetentionEndTime()

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()

publicabstractTimestampOrBuildergetEnforcedRetentionEndTimeOrBuilder()

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()

publicabstractStringgetEtag()

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()

publicabstractByteStringgetEtagBytes()

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()

publicabstractTimestampgetExpireTime()

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()

publicabstractTimestampOrBuildergetExpireTimeOrBuilder()

Optional. When this backup is automatically expired.

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

Returns
Type Description
TimestampOrBuilder

getGcpBackupPlanInfo()

publicabstractBackup.GCPBackupPlanInfogetGcpBackupPlanInfo()

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()

publicabstractBackup.GCPBackupPlanInfoOrBuildergetGcpBackupPlanInfoOrBuilder()

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

getGcpResource()

publicabstractBackupGcpResourcegetGcpResource()

Output only. Unique identifier of the GCP resource that is being backed up.

.google.cloud.backupdr.v1.BackupGcpResource gcp_resource = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupGcpResource

The gcpResource.

getGcpResourceOrBuilder()

publicabstractBackupGcpResourceOrBuildergetGcpResourceOrBuilder()

Output only. Unique identifier of the GCP resource that is being backed up.

.google.cloud.backupdr.v1.BackupGcpResource gcp_resource = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupGcpResourceOrBuilder

getLabels() (deprecated)

publicabstractMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

publicabstractintgetLabelsCount()

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()

publicabstractMap<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)

publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

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)

publicabstractStringgetLabelsOrThrow(Stringkey)

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()

publicabstractStringgetName()

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()

publicabstractByteStringgetNameBytes()

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()

publicabstractBackup.PlanInfoCasegetPlanInfoCase()
Returns
Type Description
Backup.PlanInfoCase

getResourceSizeBytes()

publicabstractlonggetResourceSizeBytes()

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.

getSatisfiesPzi()

publicabstractbooleangetSatisfiesPzi()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzi = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

publicabstractbooleangetSatisfiesPzs()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The satisfiesPzs.

getServiceLocks(int index)

publicabstractBackupLockgetServiceLocks(intindex)

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()

publicabstractintgetServiceLocksCount()

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()

publicabstractList<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)

publicabstractBackupLockOrBuildergetServiceLocksOrBuilder(intindex)

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()

publicabstractList<?extendsBackupLockOrBuilder>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>

getSourceResourceCase()

publicabstractBackup.SourceResourceCasegetSourceResourceCase()
Returns
Type Description
Backup.SourceResourceCase

getState()

publicabstractBackup.StategetState()

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()

publicabstractintgetStateValue()

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()

publicabstractTimestampgetUpdateTime()

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()

publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()

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()

publicabstractbooleanhasBackupApplianceBackupProperties()

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.

hasCloudSqlInstanceBackupProperties()

publicabstractbooleanhasCloudSqlInstanceBackupProperties()

Output only. Cloud SQL specific backup properties.

.google.cloud.backupdr.v1.CloudSqlInstanceBackupProperties cloud_sql_instance_backup_properties = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the cloudSqlInstanceBackupProperties field is set.

hasComputeInstanceBackupProperties()

publicabstractbooleanhasComputeInstanceBackupProperties()

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()

publicabstractbooleanhasConsistencyTime()

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()

publicabstractbooleanhasCreateTime()

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()

publicabstractbooleanhasDescription()

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.

hasDiskBackupProperties()

publicabstractbooleanhasDiskBackupProperties()

Output only. Disk specific backup properties.

.google.cloud.backupdr.v1.DiskBackupProperties disk_backup_properties = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the diskBackupProperties field is set.

hasEnforcedRetentionEndTime()

publicabstractbooleanhasEnforcedRetentionEndTime()

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()

publicabstractbooleanhasEtag()

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()

publicabstractbooleanhasExpireTime()

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()

publicabstractbooleanhasGcpBackupPlanInfo()

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.

hasGcpResource()

publicabstractbooleanhasGcpResource()

Output only. Unique identifier of the GCP resource that is being backed up.

.google.cloud.backupdr.v1.BackupGcpResource gcp_resource = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the gcpResource field is set.

hasSatisfiesPzi()

publicabstractbooleanhasSatisfiesPzi()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzi = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

publicabstractbooleanhasSatisfiesPzs()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasUpdateTime()

publicabstractbooleanhasUpdateTime()

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年11月19日 UTC.