public static final class BackupVault.Builder extends GeneratedMessageV3.Builder<BackupVault.Builder> implements BackupVaultOrBuilder
Message describing a BackupVault object.
Protobuf type google.cloud.backupdr.v1.BackupVault
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BackupVault.BuilderImplements
BackupVaultOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BackupVault.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
build()
public BackupVault build()
Returns | |
---|---|
Type | Description |
BackupVault |
buildPartial()
public BackupVault buildPartial()
Returns | |
---|---|
Type | Description |
BackupVault |
clear()
public BackupVault.Builder clear()
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
clearAccessRestriction()
public BackupVault.Builder clearAccessRestriction()
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.Builder |
This builder for chaining. |
clearAnnotations()
public BackupVault.Builder clearAnnotations()
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
clearBackupCount()
public BackupVault.Builder clearBackupCount()
Output only. The number of backups in this backup vault.
int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
clearBackupMinimumEnforcedRetentionDuration()
public BackupVault.Builder clearBackupMinimumEnforcedRetentionDuration()
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 |
BackupVault.Builder |
clearCreateTime()
public BackupVault.Builder clearCreateTime()
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 |
BackupVault.Builder |
clearDeletable()
public BackupVault.Builder clearDeletable()
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 |
BackupVault.Builder |
This builder for chaining. |
clearDescription()
public BackupVault.Builder clearDescription()
Optional. The description of the BackupVault instance (2048 characters or less).
optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
clearEffectiveTime()
public BackupVault.Builder clearEffectiveTime()
Optional. Time after which the BackupVault resource is locked.
optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
clearEtag()
public BackupVault.Builder clearEtag()
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 |
BackupVault.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public BackupVault.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
clearLabels()
public BackupVault.Builder clearLabels()
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
clearName()
public BackupVault.Builder clearName()
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 |
BackupVault.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public BackupVault.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
clearServiceAccount()
public BackupVault.Builder clearServiceAccount()
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 |
BackupVault.Builder |
This builder for chaining. |
clearState()
public BackupVault.Builder clearState()
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.Builder |
This builder for chaining. |
clearTotalStoredBytes()
public BackupVault.Builder clearTotalStoredBytes()
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 |
BackupVault.Builder |
This builder for chaining. |
clearUid()
public BackupVault.Builder clearUid()
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 |
BackupVault.Builder |
This builder for chaining. |
clearUpdateTime()
public BackupVault.Builder clearUpdateTime()
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 |
BackupVault.Builder |
clone()
public BackupVault.Builder clone()
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
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 |
Returns | |
---|---|
Type | Description |
boolean |
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 |
Returns | |
---|---|
Type | Description |
boolean |
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];
Returns | |
---|---|
Type | Description |
BackupVault.AccessRestriction |
The accessRestriction. |
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()
Use #getAnnotationsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
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];
Returns | |
---|---|
Type | Description |
Map<String,String> |
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];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
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. |
getBackupMinimumEnforcedRetentionDurationBuilder()
public Duration.Builder getBackupMinimumEnforcedRetentionDurationBuilder()
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 |
Builder |
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];
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
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 |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public BackupVault getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
BackupVault |
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getEffectiveTimeBuilder()
public Timestamp.Builder getEffectiveTimeBuilder()
Optional. Time after which the BackupVault resource is locked.
optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getEtag()
public 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 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()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
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];
Returns | |
---|---|
Type | Description |
Map<String,String> |
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];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
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 |
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public 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. |
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];
Returns | |
---|---|
Type | Description |
BackupVault.State |
The state. |
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()
public 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
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 |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeBackupMinimumEnforcedRetentionDuration(Duration value)
public BackupVault.Builder mergeBackupMinimumEnforcedRetentionDuration(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
mergeCreateTime(Timestamp value)
public BackupVault.Builder mergeCreateTime(Timestamp value)
Output only. The time when the instance was created.
optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
mergeEffectiveTime(Timestamp value)
public BackupVault.Builder mergeEffectiveTime(Timestamp value)
Optional. Time after which the BackupVault resource is locked.
optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
mergeFrom(BackupVault other)
public BackupVault.Builder mergeFrom(BackupVault other)
Parameter | |
---|---|
Name | Description |
other |
BackupVault |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BackupVault.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public BackupVault.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BackupVault.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
mergeUpdateTime(Timestamp value)
public BackupVault.Builder mergeUpdateTime(Timestamp value)
Output only. The time when the instance was updated.
optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
putAllAnnotations(Map<String,String> values)
public BackupVault.Builder putAllAnnotations(Map<String,String> values)
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 |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
putAllLabels(Map<String,String> values)
public BackupVault.Builder putAllLabels(Map<String,String> values)
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 |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
putAnnotations(String key, String value)
public BackupVault.Builder putAnnotations(String key, String value)
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 |
value |
String |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
putLabels(String key, String value)
public BackupVault.Builder putLabels(String key, String value)
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 |
value |
String |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
removeAnnotations(String key)
public BackupVault.Builder removeAnnotations(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 |
BackupVault.Builder |
removeLabels(String key)
public BackupVault.Builder removeLabels(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 |
BackupVault.Builder |
setAccessRestriction(BackupVault.AccessRestriction value)
public BackupVault.Builder setAccessRestriction(BackupVault.AccessRestriction value)
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];
Parameter | |
---|---|
Name | Description |
value |
BackupVault.AccessRestriction The accessRestriction to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setAccessRestrictionValue(int value)
public BackupVault.Builder setAccessRestrictionValue(int value)
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];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for accessRestriction to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setBackupCount(long value)
public BackupVault.Builder setBackupCount(long value)
Output only. The number of backups in this backup vault.
int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The backupCount to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setBackupMinimumEnforcedRetentionDuration(Duration value)
public BackupVault.Builder setBackupMinimumEnforcedRetentionDuration(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setBackupMinimumEnforcedRetentionDuration(Duration.Builder builderForValue)
public BackupVault.Builder setBackupMinimumEnforcedRetentionDuration(Duration.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setCreateTime(Timestamp value)
public BackupVault.Builder setCreateTime(Timestamp value)
Output only. The time when the instance was created.
optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public BackupVault.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The time when the instance was created.
optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setDeletable(boolean value)
public BackupVault.Builder setDeletable(boolean value)
Output only. Set to true when there are no backups nested under this resource.
optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
boolean The deletable to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setDescription(String value)
public BackupVault.Builder setDescription(String value)
Optional. The description of the BackupVault instance (2048 characters or less).
optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public BackupVault.Builder setDescriptionBytes(ByteString value)
Optional. The description of the BackupVault instance (2048 characters or less).
optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setEffectiveTime(Timestamp value)
public BackupVault.Builder setEffectiveTime(Timestamp value)
Optional. Time after which the BackupVault resource is locked.
optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setEffectiveTime(Timestamp.Builder builderForValue)
public BackupVault.Builder setEffectiveTime(Timestamp.Builder builderForValue)
Optional. Time after which the BackupVault resource is locked.
optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setEtag(String value)
public BackupVault.Builder setEtag(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The etag to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public BackupVault.Builder setEtagBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public BackupVault.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setName(String value)
public BackupVault.Builder setName(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public BackupVault.Builder setNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BackupVault.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setServiceAccount(String value)
public BackupVault.Builder setServiceAccount(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The serviceAccount to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setServiceAccountBytes(ByteString value)
public BackupVault.Builder setServiceAccountBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for serviceAccount to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setState(BackupVault.State value)
public BackupVault.Builder setState(BackupVault.State value)
Output only. The BackupVault resource instance state.
.google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
BackupVault.State The state to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setStateValue(int value)
public BackupVault.Builder setStateValue(int value)
Output only. The BackupVault resource instance state.
.google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setTotalStoredBytes(long value)
public BackupVault.Builder setTotalStoredBytes(long value)
Output only. Total size of the storage used by all backup resources.
int64 total_stored_bytes = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The totalStoredBytes to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setUid(String value)
public BackupVault.Builder setUid(String value)
Output only. Output only Immutable after resource creation until resource deletion.
string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The uid to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public BackupVault.Builder setUidBytes(ByteString value)
Output only. Output only Immutable after resource creation until resource deletion.
string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BackupVault.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setUpdateTime(Timestamp value)
public BackupVault.Builder setUpdateTime(Timestamp value)
Output only. The time when the instance was updated.
optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public BackupVault.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The time when the instance was updated.
optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
BackupVault.Builder |