public final class Backup extends GeneratedMessageV3 implements BackupOrBuilder
Message describing Backup object
Protobuf type google.cloud.alloydb.v1alpha.Backup
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLUSTER_UID_FIELD_NUMBER
public static final int CLUSTER_UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENCRYPTION_INFO_FIELD_NUMBER
public static final int ENCRYPTION_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPIRY_TIME_FIELD_NUMBER
public static final int EXPIRY_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SIZE_BYTES_FIELD_NUMBER
public static final int SIZE_BYTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Backup getDefaultInstance()
| Returns |
| Type |
Description |
Backup |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Backup.Builder newBuilder()
newBuilder(Backup prototype)
public static Backup.Builder newBuilder(Backup prototype)
| Parameter |
| Name |
Description |
prototype |
Backup
|
public static Backup parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(byte[] data)
public static Backup parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Backup |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteString data)
public static Backup parseFrom(ByteString data)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(InputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteBuffer data)
public static Backup parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parser()
public static Parser<Backup> parser()
Methods
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 |
| Name |
Description |
key |
String
|
containsLabels(String key)
public boolean containsLabels(String key)
Labels as key value pairs
map<string, string> labels = 6;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
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 |
| Type |
Description |
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;
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;
| Returns |
| Type |
Description |
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 |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getClusterName()
public String getClusterName()
Required. The full resource name of the backup source cluster
(e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).
string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The clusterName.
|
getClusterNameBytes()
public ByteString getClusterNameBytes()
Required. The full resource name of the backup source cluster
(e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).
string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Backup getDefaultInstanceForType()
| Returns |
| Type |
Description |
Backup |
|
getDeleteTime()
public Timestamp getDeleteTime()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The deleteTime.
|
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDescription()
public String getDescription()
User-provided description of the backup.
string description = 9;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
User-provided description of the backup.
string description = 9;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
User-settable and human-readable display name for the Backup.
string display_name = 2;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public 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 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.v1alpha.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
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.v1alpha.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
getEncryptionInfo()
public EncryptionInfo getEncryptionInfo()
Output only. The encryption information for the backup.
.google.cloud.alloydb.v1alpha.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEncryptionInfoOrBuilder()
public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
Output only. The encryption information for the backup.
.google.cloud.alloydb.v1alpha.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEtag()
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
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 |
| Type |
Description |
Timestamp |
The expiryTime.
|
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];
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Labels as key value pairs
map<string, string> labels = 6;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels as key value pairs
map<string, string> labels = 6;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairs
map<string, string> labels = 6;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels as key value pairs
map<string, string> labels = 6;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Backup> getParserForType()
Overrides
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 |
| Type |
Description |
boolean |
The reconciling.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSizeBytes()
public long getSizeBytes()
Output only. The size of the backup in bytes.
int64 size_bytes = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The sizeBytes.
|
getState()
public Backup.State getState()
Output only. The current state of the backup.
.google.cloud.alloydb.v1alpha.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The current state of the backup.
.google.cloud.alloydb.v1alpha.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
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.v1alpha.Backup.Type type = 8;
getTypeValue()
public int getTypeValue()
The backup type, which suggests the trigger for the backup.
.google.cloud.alloydb.v1alpha.Backup.Type type = 8;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for type.
|
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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.v1alpha.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the encryptionConfig field is set.
|
hasEncryptionInfo()
public boolean hasEncryptionInfo()
Output only. The encryption information for the backup.
.google.cloud.alloydb.v1alpha.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the encryptionInfo 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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Backup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Backup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Backup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
