public final class BackupVault extends GeneratedMessageV3 implements BackupVaultOrBuilder
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
public static final int ACCESS_RESTRICTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_COUNT_FIELD_NUMBER
public static final int BACKUP_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_MINIMUM_ENFORCED_RETENTION_DURATION_FIELD_NUMBER
public static final int BACKUP_MINIMUM_ENFORCED_RETENTION_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DELETABLE_FIELD_NUMBER
public static final int DELETABLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EFFECTIVE_TIME_FIELD_NUMBER
public static final int EFFECTIVE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_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 |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOTAL_STORED_BYTES_FIELD_NUMBER
public static final int TOTAL_STORED_BYTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_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 BackupVault getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BackupVault.Builder newBuilder()
newBuilder(BackupVault prototype)
public static BackupVault.Builder newBuilder(BackupVault prototype)
public static BackupVault parseDelimitedFrom(InputStream input)
public static BackupVault parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BackupVault parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BackupVault parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BackupVault parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackupVault parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackupVault parseFrom(CodedInputStream input)
public static BackupVault parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BackupVault parseFrom(InputStream input)
public static BackupVault parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BackupVault parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BackupVault parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BackupVault> parser()
Methods
containsAnnotations(String key)
public 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
|
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAccessRestriction()
public 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];
getAccessRestrictionValue()
public 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 Map<String,String> getAnnotations()
getAnnotationsCount()
public 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 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];
getAnnotationsOrDefault(String key, String defaultValue)
public 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];
| Returns |
| Type |
Description |
String |
|
getAnnotationsOrThrow(String key)
public 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 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 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 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];
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the instance was created.
optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public BackupVault getDefaultInstanceForType()
getDeletable()
public 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 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 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 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 TimestampOrBuilder getEffectiveTimeOrBuilder()
Optional. Time after which the BackupVault resource is locked.
optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
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 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 Map<String,String> getLabels()
getLabelsCount()
public 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 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];
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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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 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.
|
getParserForType()
public Parser<BackupVault> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServiceAccount()
public 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 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 BackupVault.State getState()
Output only. The BackupVault resource instance state.
.google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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 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()
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 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 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the instance was updated.
optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasBackupMinimumEnforcedRetentionDuration()
public 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 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 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 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 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()
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 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.
|
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 BackupVault.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BackupVault.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BackupVault.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
