Interface BackupVaultOrBuilder (0.11.0) 

public interface BackupVaultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

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)

public abstract boolean containsLabels(String key)

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

public abstract BackupVault.AccessRestriction getAccessRestriction()

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

public abstract int getAccessRestrictionValue()

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)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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

public abstract Map<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)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

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)

public abstract String getAnnotationsOrThrow(String key)

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

public abstract long getBackupCount()

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

public abstract Duration getBackupMinimumEnforcedRetentionDuration()

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

public abstract DurationOrBuilder getBackupMinimumEnforcedRetentionDurationOrBuilder()

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

public abstract Timestamp getCreateTime()

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

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

public abstract boolean getDeletable()

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

public abstract String getDescription()

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

public abstract ByteString getDescriptionBytes()

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

public abstract Timestamp getEffectiveTime()

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

public abstract TimestampOrBuilder getEffectiveTimeOrBuilder()

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

public abstract String getEtag()

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

public abstract ByteString getEtagBytes()

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)

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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.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 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()

public abstract ByteString getNameBytes()

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

public abstract String getServiceAccount()

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

public abstract ByteString getServiceAccountBytes()

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

public abstract BackupVault.State getState()

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

public abstract int getStateValue()

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

public abstract long getTotalStoredBytes()

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

public abstract String getUid()

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

public abstract ByteString getUidBytes()

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

public abstract Timestamp getUpdateTime()

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

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

public abstract boolean hasBackupMinimumEnforcedRetentionDuration()

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

public abstract boolean hasCreateTime()

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

public abstract boolean hasDeletable()

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

public abstract boolean hasDescription()

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

public abstract boolean hasEffectiveTime()

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

public abstract boolean hasEtag()

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

public abstract boolean hasUpdateTime()

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.