public interface BackupOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsAnnotations(String key)
public abstract 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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsLabels(String key)
public abstract boolean containsLabels(String key)Labels as key value pairs
map<string, string> labels = 6;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnnotations()
public abstract Map<String,String> getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
|
getAnnotationsMap()
public abstract 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 | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsOrDefault(String key, String defaultValue)
public abstract 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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getAnnotationsOrThrow(String key)
public abstract 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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getClusterName()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
String |
The clusterName. |
getClusterNameBytes()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clusterName. |
getClusterUid()
public abstract String getClusterUid()Output only. The system-generated UID of the cluster which was used to create this resource.
string cluster_uid = 18;
| Returns | |
|---|---|
| Type | Description |
String |
The clusterUid. |
getClusterUidBytes()
public abstract ByteString getClusterUidBytes()Output only. The system-generated UID of the cluster which was used to create this resource.
string cluster_uid = 18;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clusterUid. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDeleteTime()
public abstract Timestamp getDeleteTime()Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 15;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeOrBuilder()
public abstract TimestampOrBuilder getDeleteTimeOrBuilder()Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 15;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescription()
public abstract String getDescription()User-provided description of the backup.
string description = 9;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()User-provided description of the backup.
string description = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract String getDisplayName()User-settable and human-readable display name for the Backup.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()User-settable and human-readable display name for the Backup.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEncryptionConfig()
public abstract 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.events.cloud.alloydb.v1.EncryptionConfig encryption_config = 12;
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig |
The encryptionConfig. |
getEncryptionConfigOrBuilder()
public abstract 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.events.cloud.alloydb.v1.EncryptionConfig encryption_config = 12;
| Returns | |
|---|---|
| Type | Description |
EncryptionConfigOrBuilder |
|
getEncryptionInfo()
public abstract EncryptionInfo getEncryptionInfo()Output only. The encryption information for the backup.
.google.events.cloud.alloydb.v1.EncryptionInfo encryption_info = 13;
| Returns | |
|---|---|
| Type | Description |
EncryptionInfo |
The encryptionInfo. |
getEncryptionInfoOrBuilder()
public abstract EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()Output only. The encryption information for the backup.
.google.events.cloud.alloydb.v1.EncryptionInfo encryption_info = 13;
| Returns | |
|---|---|
| Type | Description |
EncryptionInfoOrBuilder |
|
getEtag()
public abstract String getEtag()For Resource freshness validation (https://google.aip.dev/154)
string etag = 14;
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public abstract ByteString getEtagBytes()For Resource freshness validation (https://google.aip.dev/154)
string etag = 14;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getExpiryTime()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The expiryTime. |
getExpiryTimeOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract int getLabelsCount()Labels as key value pairs
map<string, string> labels = 6;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract Map<String,String> getLabelsMap()Labels as key value pairs
map<string, string> labels = 6;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)Labels as key value pairs
map<string, string> labels = 6;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)Labels as key value pairs
map<string, string> labels = 6;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getReconciling()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The reconciling. |
getSizeBytes()
public abstract long getSizeBytes()Output only. The size of the backup in bytes.
int64 size_bytes = 17;
| Returns | |
|---|---|
| Type | Description |
long |
The sizeBytes. |
getState()
public abstract Backup.State getState()Output only. The current state of the backup.
.google.events.cloud.alloydb.v1.Backup.State state = 7;
| Returns | |
|---|---|
| Type | Description |
Backup.State |
The state. |
getStateValue()
public abstract int getStateValue()Output only. The current state of the backup.
.google.events.cloud.alloydb.v1.Backup.State state = 7;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getType()
public abstract Backup.Type getType()The backup type, which suggests the trigger for the backup.
.google.events.cloud.alloydb.v1.Backup.Type type = 8;
| Returns | |
|---|---|
| Type | Description |
Backup.Type |
The type. |
getTypeValue()
public abstract int getTypeValue()The backup type, which suggests the trigger for the backup.
.google.events.cloud.alloydb.v1.Backup.Type type = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
getUid()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
String |
The uid. |
getUidBytes()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uid. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDeleteTime()
public abstract boolean hasDeleteTime()Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deleteTime field is set. |
hasEncryptionConfig()
public abstract 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.events.cloud.alloydb.v1.EncryptionConfig encryption_config = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionConfig field is set. |
hasEncryptionInfo()
public abstract boolean hasEncryptionInfo()Output only. The encryption information for the backup.
.google.events.cloud.alloydb.v1.EncryptionInfo encryption_info = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionInfo field is set. |
hasExpiryTime()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expiryTime field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |