public final class Backup extends GeneratedMessageV3 implements BackupOrBuilder
Message describing a Backup object.
Protobuf type google.cloud.backupdr.v1.Backup
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
BACKUP_APPLIANCE_BACKUP_PROPERTIES_FIELD_NUMBER
public static final int BACKUP_APPLIANCE_BACKUP_PROPERTIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_APPLIANCE_LOCKS_FIELD_NUMBER
public static final int BACKUP_APPLIANCE_LOCKS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_TYPE_FIELD_NUMBER
public static final int BACKUP_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMPUTE_INSTANCE_BACKUP_PROPERTIES_FIELD_NUMBER
public static final int COMPUTE_INSTANCE_BACKUP_PROPERTIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONSISTENCY_TIME_FIELD_NUMBER
public static final int CONSISTENCY_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENFORCED_RETENTION_END_TIME_FIELD_NUMBER
public static final int ENFORCED_RETENTION_END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GCP_BACKUP_PLAN_INFO_FIELD_NUMBER
public static final int GCP_BACKUP_PLAN_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_SIZE_BYTES_FIELD_NUMBER
public static final int RESOURCE_SIZE_BYTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVICE_LOCKS_FIELD_NUMBER
public static final int SERVICE_LOCKS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_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 Backup getDefaultInstance()
| Returns |
| Type |
Description |
Backup |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Backup.Builder newBuilder()
newBuilder(Backup prototype)
public static Backup.Builder newBuilder(Backup prototype)
| Parameter |
| Name |
Description |
prototype |
Backup
|
public static Backup parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(byte[] data)
public static Backup parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Backup |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteString data)
public static Backup parseFrom(ByteString data)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(InputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteBuffer data)
public static Backup parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parser()
public static Parser<Backup> parser()
Methods
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackupApplianceBackupProperties()
public 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];
getBackupApplianceBackupPropertiesOrBuilder()
public 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];
getBackupApplianceLocks(int index)
public 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
|
getBackupApplianceLocksCount()
public 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 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];
getBackupApplianceLocksOrBuilder(int index)
public 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
|
getBackupApplianceLocksOrBuilderList()
public 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 Backup.BackupPropertiesCase getBackupPropertiesCase()
getBackupType()
public 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];
getBackupTypeValue()
public 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 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];
getComputeInstanceBackupPropertiesOrBuilder()
public 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];
getConsistencyTime()
public 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 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];
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the instance was created.
optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Backup getDefaultInstanceForType()
| Returns |
| Type |
Description |
Backup |
|
getDescription()
public 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 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 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 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];
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 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 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 TimestampOrBuilder getExpireTimeOrBuilder()
Optional. When this backup is automatically expired.
optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL];
getGcpBackupPlanInfo()
public 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];
getGcpBackupPlanInfoOrBuilder()
public 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];
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public 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 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];
getLabelsOrDefault(String key, String defaultValue)
public 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];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public 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()
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 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.
|
getParserForType()
public Parser<Backup> getParserForType()
Overrides
getPlanInfoCase()
public Backup.PlanInfoCase getPlanInfoCase()
getResourceSizeBytes()
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServiceLocks(int index)
public 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
|
getServiceLocksCount()
public 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 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];
getServiceLocksOrBuilder(int index)
public 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
|
getServiceLocksOrBuilderList()
public 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 Backup.State getState()
Output only. The Backup resource instance state.
.google.cloud.backupdr.v1.Backup.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the instance was updated.
optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasBackupApplianceBackupProperties()
public 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 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 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 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 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 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()
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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Backup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Backup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Backup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
