Interface BackupVaultOrBuilder (0.26.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface BackupVaultOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsAnnotations(String key)
publicabstractbooleancontainsAnnotations(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)
publicabstractbooleancontainsLabels(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 |
|
getAccessRestriction()
publicabstractBackupVault.AccessRestrictiongetAccessRestriction()Optional. Note: This field is added for future use case and will not be supported in the current release.
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()
publicabstractintgetAccessRestrictionValue()Optional. Note: This field is added for future use case and will not be supported in the current release.
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)
publicabstractMap<String,String>getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
publicabstractintgetAnnotationsCount()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()
publicabstractMap<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)
publicabstractStringgetAnnotationsOrDefault(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)
publicabstractStringgetAnnotationsOrThrow(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()
publicabstractlonggetBackupCount()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()
publicabstractDurationgetBackupMinimumEnforcedRetentionDuration()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()
publicabstractDurationOrBuildergetBackupMinimumEnforcedRetentionDurationOrBuilder()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()
publicabstractTimestampgetCreateTime()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()
publicabstractTimestampOrBuildergetCreateTimeOrBuilder()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 |
|
getDeletable()
publicabstractbooleangetDeletable()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()
publicabstractStringgetDescription()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()
publicabstractByteStringgetDescriptionBytes()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()
publicabstractTimestampgetEffectiveTime()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()
publicabstractTimestampOrBuildergetEffectiveTimeOrBuilder()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()
publicabstractStringgetEtag()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()
publicabstractByteStringgetEtagBytes()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)
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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
publicabstractStringgetName() 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()
publicabstractByteStringgetNameBytes() 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. |
getServiceAccount()
publicabstractStringgetServiceAccount()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()
publicabstractByteStringgetServiceAccountBytes()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()
publicabstractBackupVault.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()
publicabstractintgetStateValue()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()
publicabstractlonggetTotalStoredBytes()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()
publicabstractStringgetUid()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()
publicabstractByteStringgetUidBytes()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()
publicabstractTimestampgetUpdateTime()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()
publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()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()
publicabstractbooleanhasBackupMinimumEnforcedRetentionDuration()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()
publicabstractbooleanhasCreateTime()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()
publicabstractbooleanhasDeletable()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()
publicabstractbooleanhasDescription()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()
publicabstractbooleanhasEffectiveTime()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()
publicabstractbooleanhasEtag()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()
publicabstractbooleanhasUpdateTime()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. |