Class BackupVault (0.14.0)

publicfinalclass BackupVaultextendsGeneratedMessageV3implementsBackupVaultOrBuilder

Message describing a BackupVault object.

Protobuf type google.cloud.backupdr.v1.BackupVault

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

ACCESS_RESTRICTION_FIELD_NUMBER

publicstaticfinalintACCESS_RESTRICTION_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATIONS_FIELD_NUMBER

publicstaticfinalintANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_COUNT_FIELD_NUMBER

publicstaticfinalintBACKUP_COUNT_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_MINIMUM_ENFORCED_RETENTION_DURATION_FIELD_NUMBER

publicstaticfinalintBACKUP_MINIMUM_ENFORCED_RETENTION_DURATION_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETABLE_FIELD_NUMBER

publicstaticfinalintDELETABLE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EFFECTIVE_TIME_FIELD_NUMBER

publicstaticfinalintEFFECTIVE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

publicstaticfinalintETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

publicstaticfinalintLABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

publicstaticfinalintSERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_STORED_BYTES_FIELD_NUMBER

publicstaticfinalintTOTAL_STORED_BYTES_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

publicstaticfinalintUID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

publicstaticfinalintUPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticBackupVaultgetDefaultInstance()
Returns
Type Description
BackupVault

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticBackupVault.BuildernewBuilder()
Returns
Type Description
BackupVault.Builder

newBuilder(BackupVault prototype)

publicstaticBackupVault.BuildernewBuilder(BackupVaultprototype)
Parameter
Name Description
prototype BackupVault
Returns
Type Description
BackupVault.Builder

parseDelimitedFrom(InputStream input)

publicstaticBackupVaultparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupVault
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBackupVaultparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupVault
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticBackupVaultparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackupVault
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticBackupVaultparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupVault
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticBackupVaultparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupVault
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticBackupVaultparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupVault
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticBackupVaultparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupVault
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBackupVaultparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupVault
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticBackupVaultparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupVault
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBackupVaultparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupVault
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticBackupVaultparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupVault
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticBackupVaultparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupVault
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<BackupVault>parser()
Returns
Type Description
Parser<BackupVault>

Methods

containsAnnotations(String key)

publicbooleancontainsAnnotations(Stringkey)

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

publicbooleancontainsLabels(Stringkey)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessRestriction()

publicBackupVault.AccessRestrictiongetAccessRestriction()

Optional. Note: This field is added for future use case and will not be supported in the current release.

Optional.

Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.

.google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BackupVault.AccessRestriction

The accessRestriction.

getAccessRestrictionValue()

publicintgetAccessRestrictionValue()

Optional. Note: This field is added for future use case and will not be supported in the current release.

Optional.

Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.

.google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for accessRestriction.

getAnnotations() (deprecated)

publicMap<String,String>getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

publicintgetAnnotationsCount()

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

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

Returns
Type Description
int

getAnnotationsMap()

publicMap<String,String>getAnnotationsMap()

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

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

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

publicStringgetAnnotationsOrDefault(Stringkey,StringdefaultValue)

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

publicStringgetAnnotationsOrThrow(Stringkey)

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

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

Parameter
Name Description
key String
Returns
Type Description
String

getBackupCount()

publiclonggetBackupCount()

Output only. The number of backups in this backup vault.

int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The backupCount.

getBackupMinimumEnforcedRetentionDuration()

publicDurationgetBackupMinimumEnforcedRetentionDuration()

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The backupMinimumEnforcedRetentionDuration.

getBackupMinimumEnforcedRetentionDurationOrBuilder()

publicDurationOrBuildergetBackupMinimumEnforcedRetentionDurationOrBuilder()

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getCreateTime()

publicTimestampgetCreateTime()

Output only. The time when the instance was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. The time when the instance was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

publicBackupVaultgetDefaultInstanceForType()
Returns
Type Description
BackupVault

getDeletable()

publicbooleangetDeletable()

Output only. Set to true when there are no backups nested under this resource.

optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The deletable.

getDescription()

publicStringgetDescription()

Optional. The description of the BackupVault instance (2048 characters or less).

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

Returns
Type Description
String

The description.

getDescriptionBytes()

publicByteStringgetDescriptionBytes()

Optional. The description of the BackupVault instance (2048 characters or less).

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

Returns
Type Description
ByteString

The bytes for description.

getEffectiveTime()

publicTimestampgetEffectiveTime()

Optional. Time after which the BackupVault resource is locked.

optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The effectiveTime.

getEffectiveTimeOrBuilder()

publicTimestampOrBuildergetEffectiveTimeOrBuilder()

Optional. Time after which the BackupVault resource is locked.

optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getEtag()

publicStringgetEtag()

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

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

Returns
Type Description
String

The etag.

getEtagBytes()

publicByteStringgetEtagBytes()

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

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

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

publicintgetLabelsCount()

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

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

Returns
Type Description
int

getLabelsMap()

publicMap<String,String>getLabelsMap()

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

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

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

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

publicStringgetLabelsOrThrow(Stringkey)

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getName()

publicStringgetName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

publicParser<BackupVault>getParserForType()
Returns
Type Description
Parser<BackupVault>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

publicStringgetServiceAccount()

Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

publicByteStringgetServiceAccountBytes()

Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccount.

getState()

publicBackupVault.StategetState()

Output only. The BackupVault resource instance state.

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

Returns
Type Description
BackupVault.State

The state.

getStateValue()

publicintgetStateValue()

Output only. The BackupVault resource instance state.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getTotalStoredBytes()

publiclonggetTotalStoredBytes()

Output only. Total size of the storage used by all backup resources.

int64 total_stored_bytes = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The totalStoredBytes.

getUid()

publicStringgetUid()

Output only. Output only Immutable after resource creation until resource deletion.

string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

publicByteStringgetUidBytes()

Output only. Output only Immutable after resource creation until resource deletion.

string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

publicTimestampgetUpdateTime()

Output only. The time when the instance was updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

publicTimestampOrBuildergetUpdateTimeOrBuilder()

Output only. The time when the instance was updated.

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

Returns
Type Description
TimestampOrBuilder

hasBackupMinimumEnforcedRetentionDuration()

publicbooleanhasBackupMinimumEnforcedRetentionDuration()

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backupMinimumEnforcedRetentionDuration field is set.

hasCreateTime()

publicbooleanhasCreateTime()

Output only. The time when the instance was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeletable()

publicbooleanhasDeletable()

Output only. Set to true when there are no backups nested under this resource.

optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deletable field is set.

hasDescription()

publicbooleanhasDescription()

Optional. The description of the BackupVault instance (2048 characters or less).

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

Returns
Type Description
boolean

Whether the description field is set.

hasEffectiveTime()

publicbooleanhasEffectiveTime()

Optional. Time after which the BackupVault resource is locked.

optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the effectiveTime field is set.

hasEtag()

publicbooleanhasEtag()

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

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

Returns
Type Description
boolean

Whether the etag field is set.

hasUpdateTime()

publicbooleanhasUpdateTime()

Output only. The time when the instance was updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicBackupVault.BuildernewBuilderForType()
Returns
Type Description
BackupVault.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedBackupVault.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackupVault.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicBackupVault.BuildertoBuilder()
Returns
Type Description
BackupVault.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

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.