Class Backup.Builder (0.17.0)

public static final class Backup.Builder extends GeneratedMessageV3.Builder<Backup.Builder> implements BackupOrBuilder

Message describing Backup object

Protobuf type google.cloud.alloydb.v1beta.Backup

Implements

BackupOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Backup.Builder
Overrides

build()

public Backup build()
Returns
TypeDescription
Backup

buildPartial()

public Backup buildPartial()
Returns
TypeDescription
Backup

clear()

public Backup.Builder clear()
Returns
TypeDescription
Backup.Builder
Overrides

clearAnnotations()

public Backup.Builder clearAnnotations()
Returns
TypeDescription
Backup.Builder

clearClusterName()

public Backup.Builder clearClusterName()

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearClusterUid()

public Backup.Builder clearClusterUid()

Output only. The system-generated UID of the cluster which was used to create this resource.

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

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearCreateTime()

public Backup.Builder clearCreateTime()

Output only. Create time stamp

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

Returns
TypeDescription
Backup.Builder

clearDatabaseVersion()

public Backup.Builder clearDatabaseVersion()

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearDeleteTime()

public Backup.Builder clearDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

clearDescription()

public Backup.Builder clearDescription()

User-provided description of the backup.

string description = 9;

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearDisplayName()

public Backup.Builder clearDisplayName()

User-settable and human-readable display name for the Backup.

string display_name = 2;

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearEncryptionConfig()

public Backup.Builder clearEncryptionConfig()

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Backup.Builder

clearEncryptionInfo()

public Backup.Builder clearEncryptionInfo()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

clearEtag()

public Backup.Builder clearEtag()

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearExpiryQuantity()

public Backup.Builder clearExpiryQuantity()

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

clearExpiryTime()

public Backup.Builder clearExpiryTime()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

clearField(Descriptors.FieldDescriptor field)

public Backup.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Backup.Builder
Overrides

clearLabels()

public Backup.Builder clearLabels()
Returns
TypeDescription
Backup.Builder

clearName()

public Backup.Builder clearName()

Output only. The name of the backup resource with the format:

  • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
  • projects/{project}/locations/{region}

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

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Backup.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Backup.Builder
Overrides

clearReconciling()

public Backup.Builder clearReconciling()

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

bool reconciling = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearSizeBytes()

public Backup.Builder clearSizeBytes()

Output only. The size of the backup in bytes.

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

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearState()

public Backup.Builder clearState()

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearType()

public Backup.Builder clearType()

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearUid()

public Backup.Builder clearUid()

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearUpdateTime()

public Backup.Builder clearUpdateTime()

Output only. Update time stamp

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

Returns
TypeDescription
Backup.Builder

clone()

public Backup.Builder clone()
Returns
TypeDescription
Backup.Builder
Overrides

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getClusterName()

public String getClusterName()

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for clusterName.

getClusterUid()

public String getClusterUid()

Output only. The system-generated UID of the cluster which was used to create this resource.

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

Returns
TypeDescription
String

The clusterUid.

getClusterUidBytes()

public ByteString getClusterUidBytes()

Output only. The system-generated UID of the cluster which was used to create this resource.

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

Returns
TypeDescription
ByteString

The bytes for clusterUid.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create time stamp

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp

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

Returns
TypeDescription
TimestampOrBuilder

getDatabaseVersion()

public DatabaseVersion getDatabaseVersion()

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public int getDatabaseVersionValue()

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for databaseVersion.

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()
Returns
TypeDescription
Backup

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDescription()

public String getDescription()

User-provided description of the backup.

string description = 9;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User-provided description of the backup.

string description = 9;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

User-settable and human-readable display name for the Backup.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User-settable and human-readable display name for the Backup.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEncryptionConfig()

public EncryptionConfig getEncryptionConfig()

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EncryptionConfigOrBuilder

getEncryptionInfo()

public EncryptionInfo getEncryptionInfo()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EncryptionInfo

The encryptionInfo.

getEncryptionInfoBuilder()

public EncryptionInfo.Builder getEncryptionInfoBuilder()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EncryptionInfo.Builder

getEncryptionInfoOrBuilder()

public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EncryptionInfoOrBuilder

getEtag()

public String getEtag()

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Returns
TypeDescription
ByteString

The bytes for etag.

getExpiryQuantity()

public Backup.QuantityBasedExpiry getExpiryQuantity()

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.QuantityBasedExpiry

The expiryQuantity.

getExpiryQuantityBuilder()

public Backup.QuantityBasedExpiry.Builder getExpiryQuantityBuilder()

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.QuantityBasedExpiry.Builder

getExpiryQuantityOrBuilder()

public Backup.QuantityBasedExpiryOrBuilder getExpiryQuantityOrBuilder()

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.QuantityBasedExpiryOrBuilder

getExpiryTime()

public Timestamp getExpiryTime()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The expiryTime.

getExpiryTimeBuilder()

public Timestamp.Builder getExpiryTimeBuilder()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getExpiryTimeOrBuilder()

public TimestampOrBuilder getExpiryTimeOrBuilder()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 6;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 6;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 6;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableAnnotations()

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. The name of the backup resource with the format:

  • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
  • projects/{project}/locations/{region}

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the backup resource with the format:

  • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
  • projects/{project}/locations/{region}

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

Returns
TypeDescription
ByteString

The bytes for name.

getReconciling()

public boolean getReconciling()

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

bool reconciling = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The reconciling.

getSizeBytes()

public long getSizeBytes()

Output only. The size of the backup in bytes.

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

Returns
TypeDescription
long

The sizeBytes.

getState()

public Backup.State getState()

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getType()

public Backup.Type getType()

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Returns
TypeDescription
Backup.Type

The type.

getTypeValue()

public int getTypeValue()

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getUid()

public String getUid()

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update time stamp

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the deleteTime field is set.

hasEncryptionConfig()

public boolean hasEncryptionConfig()

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the encryptionConfig field is set.

hasEncryptionInfo()

public boolean hasEncryptionInfo()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the encryptionInfo field is set.

hasExpiryQuantity()

public boolean hasExpiryQuantity()

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the expiryQuantity field is set.

hasExpiryTime()

public boolean hasExpiryTime()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the expiryTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Backup.Builder mergeCreateTime(Timestamp value)

Output only. Create time stamp

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

mergeDeleteTime(Timestamp value)

public Backup.Builder mergeDeleteTime(Timestamp value)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

mergeEncryptionConfig(EncryptionConfig value)

public Backup.Builder mergeEncryptionConfig(EncryptionConfig value)

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueEncryptionConfig
Returns
TypeDescription
Backup.Builder

mergeEncryptionInfo(EncryptionInfo value)

public Backup.Builder mergeEncryptionInfo(EncryptionInfo value)

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueEncryptionInfo
Returns
TypeDescription
Backup.Builder

mergeExpiryQuantity(Backup.QuantityBasedExpiry value)

public Backup.Builder mergeExpiryQuantity(Backup.QuantityBasedExpiry value)

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueBackup.QuantityBasedExpiry
Returns
TypeDescription
Backup.Builder

mergeExpiryTime(Timestamp value)

public Backup.Builder mergeExpiryTime(Timestamp value)

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

mergeFrom(Backup other)

public Backup.Builder mergeFrom(Backup other)
Parameter
NameDescription
otherBackup
Returns
TypeDescription
Backup.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Backup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Backup.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Backup.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Backup.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Backup.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Backup.Builder mergeUpdateTime(Timestamp value)

Output only. Update time stamp

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

putAllAnnotations(Map<String,String> values)

public Backup.Builder putAllAnnotations(Map<String,String> values)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Backup.Builder

putAllLabels(Map<String,String> values)

public Backup.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs

map<string, string> labels = 6;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Backup.Builder

putAnnotations(String key, String value)

public Backup.Builder putAnnotations(String key, String value)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Backup.Builder

putLabels(String key, String value)

public Backup.Builder putLabels(String key, String value)

Labels as key value pairs

map<string, string> labels = 6;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Backup.Builder

removeAnnotations(String key)

public Backup.Builder removeAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter
NameDescription
keyString
Returns
TypeDescription
Backup.Builder

removeLabels(String key)

public Backup.Builder removeLabels(String key)

Labels as key value pairs

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
Backup.Builder

setClusterName(String value)

public Backup.Builder setClusterName(String value)

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The clusterName to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setClusterNameBytes(ByteString value)

public Backup.Builder setClusterNameBytes(ByteString value)

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for clusterName to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setClusterUid(String value)

public Backup.Builder setClusterUid(String value)

Output only. The system-generated UID of the cluster which was used to create this resource.

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

Parameter
NameDescription
valueString

The clusterUid to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setClusterUidBytes(ByteString value)

public Backup.Builder setClusterUidBytes(ByteString value)

Output only. The system-generated UID of the cluster which was used to create this resource.

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

Parameter
NameDescription
valueByteString

The bytes for clusterUid to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Backup.Builder setCreateTime(Timestamp value)

Output only. Create time stamp

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Backup.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create time stamp

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Backup.Builder

setDatabaseVersion(DatabaseVersion value)

public Backup.Builder setDatabaseVersion(DatabaseVersion value)

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueDatabaseVersion

The databaseVersion to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setDatabaseVersionValue(int value)

public Backup.Builder setDatabaseVersionValue(int value)

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for databaseVersion to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setDeleteTime(Timestamp value)

public Backup.Builder setDeleteTime(Timestamp value)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Backup.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Backup.Builder

setDescription(String value)

public Backup.Builder setDescription(String value)

User-provided description of the backup.

string description = 9;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Backup.Builder setDescriptionBytes(ByteString value)

User-provided description of the backup.

string description = 9;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setDisplayName(String value)

public Backup.Builder setDisplayName(String value)

User-settable and human-readable display name for the Backup.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Backup.Builder setDisplayNameBytes(ByteString value)

User-settable and human-readable display name for the Backup.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setEncryptionConfig(EncryptionConfig value)

public Backup.Builder setEncryptionConfig(EncryptionConfig value)

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueEncryptionConfig
Returns
TypeDescription
Backup.Builder

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public Backup.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueEncryptionConfig.Builder
Returns
TypeDescription
Backup.Builder

setEncryptionInfo(EncryptionInfo value)

public Backup.Builder setEncryptionInfo(EncryptionInfo value)

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueEncryptionInfo
Returns
TypeDescription
Backup.Builder

setEncryptionInfo(EncryptionInfo.Builder builderForValue)

public Backup.Builder setEncryptionInfo(EncryptionInfo.Builder builderForValue)

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueEncryptionInfo.Builder
Returns
TypeDescription
Backup.Builder

setEtag(String value)

public Backup.Builder setEtag(String value)

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Backup.Builder setEtagBytes(ByteString value)

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Backup.Builder

This builder for chaining.

setExpiryQuantity(Backup.QuantityBasedExpiry value)

public Backup.Builder setExpiryQuantity(Backup.QuantityBasedExpiry value)

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueBackup.QuantityBasedExpiry
Returns
TypeDescription
Backup.Builder

setExpiryQuantity(Backup.QuantityBasedExpiry.Builder builderForValue)

public Backup.Builder setExpiryQuantity(Backup.QuantityBasedExpiry.Builder builderForValue)

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

.google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBackup.QuantityBasedExpiry.Builder
Returns
TypeDescription
Backup.Builder

setExpiryTime(Timestamp value)

public Backup.Builder setExpiryTime(Timestamp value)

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Backup.Builder

setExpiryTime(Timestamp.Builder builderForValue)

public Backup.Builder setExpiryTime(Timestamp.Builder builderForValue)

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Backup.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Backup.Builder
Overrides

setName(String value)

public Backup.Builder setName(String value)

Output only. The name of the backup resource with the format:

  • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
  • projects/{project}/locations/{region}

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

Parameter
NameDescription
valueString

The name to set.