public interface BackupOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
A set of custom labels supplied by user.
|
boolean |
getAllNamespaces()
Output only.
|
Backup.BackupScopeCase |
getBackupScopeCase() |
Backup.ClusterMetadata |
getClusterMetadata()
Output only.
|
Backup.ClusterMetadataOrBuilder |
getClusterMetadataOrBuilder()
Output only.
|
com.google.protobuf.Timestamp |
getCompleteTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCompleteTimeOrBuilder()
Output only.
|
long |
getConfigBackupSizeBytes()
Output only.
|
boolean |
getContainsSecrets()
Output only.
|
boolean |
getContainsVolumeData()
Output only.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
int |
getDeleteLockDays()
Minimum age for this Backup (in days).
|
com.google.protobuf.Timestamp |
getDeleteLockExpireTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getDeleteLockExpireTimeOrBuilder()
Output only.
|
String |
getDescription()
User specified descriptive string for this Backup.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
User specified descriptive string for this Backup.
|
EncryptionKey |
getEncryptionKey()
Output only.
|
EncryptionKeyOrBuilder |
getEncryptionKeyOrBuilder()
Output only.
|
String |
getEtag()
Output only.
|
com.google.protobuf.ByteString |
getEtagBytes()
Output only.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
A set of custom labels supplied by user.
|
Map<String,String> |
getLabelsMap()
A set of custom labels supplied by user.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
A set of custom labels supplied by user.
|
String |
getLabelsOrThrow(String key)
A set of custom labels supplied by user.
|
boolean |
getManual()
Output only.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
int |
getPodCount()
Output only.
|
int |
getResourceCount()
Output only.
|
int |
getRetainDays()
The age (in days) after which this Backup will be automatically deleted.
|
com.google.protobuf.Timestamp |
getRetainExpireTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getRetainExpireTimeOrBuilder()
Output only.
|
NamespacedNames |
getSelectedApplications()
Output only.
|
NamespacedNamesOrBuilder |
getSelectedApplicationsOrBuilder()
Output only.
|
Namespaces |
getSelectedNamespaces()
Output only.
|
NamespacesOrBuilder |
getSelectedNamespacesOrBuilder()
Output only.
|
long |
getSizeBytes()
Output only.
|
Backup.State |
getState()
Output only.
|
String |
getStateReason()
Output only.
|
com.google.protobuf.ByteString |
getStateReasonBytes()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getUid()
Output only.
|
com.google.protobuf.ByteString |
getUidBytes()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
int |
getVolumeCount()
Output only.
|
boolean |
hasAllNamespaces()
Output only.
|
boolean |
hasClusterMetadata()
Output only.
|
boolean |
hasCompleteTime()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasDeleteLockExpireTime()
Output only.
|
boolean |
hasEncryptionKey()
Output only.
|
boolean |
hasRetainExpireTime()
Output only.
|
boolean |
hasSelectedApplications()
Output only.
|
boolean |
hasSelectedNamespaces()
Output only.
|
boolean |
hasUpdateTime()
Output only.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getName()
Output only. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*`
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getNameBytes()
Output only. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*`
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];String getUid()
Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getUidBytes()
Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean hasCreateTime()
Output only. The timestamp when this Backup resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getCreateTime()
Output only. The timestamp when this Backup resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this Backup resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasUpdateTime()
Output only. The timestamp when this Backup resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getUpdateTime()
Output only. The timestamp when this Backup resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when this Backup resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean getManual()
Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
bool manual = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];int getLabelsCount()
A set of custom labels supplied by user.
map<string, string> labels = 6;boolean containsLabels(String key)
A set of custom labels supplied by user.
map<string, string> labels = 6;@Deprecated Map<String,String> getLabels()
getLabelsMap() instead.Map<String,String> getLabelsMap()
A set of custom labels supplied by user.
map<string, string> labels = 6;String getLabelsOrDefault(String key, String defaultValue)
A set of custom labels supplied by user.
map<string, string> labels = 6;String getLabelsOrThrow(String key)
A set of custom labels supplied by user.
map<string, string> labels = 6;int getDeleteLockDays()
Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's [backup_delete_lock_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days] setting and may only be increased (either at creation time or in a subsequent update).
int32 delete_lock_days = 7;boolean hasDeleteLockExpireTime()
Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
.google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getDeleteLockExpireTime()
Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
.google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getDeleteLockExpireTimeOrBuilder()
Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
.google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
int getRetainDays()
The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days] and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's [backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days] value.
int32 retain_days = 9;boolean hasRetainExpireTime()
Output only. The time at which this Backup will be automatically deleted (calculated from create_time + [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
.google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getRetainExpireTime()
Output only. The time at which this Backup will be automatically deleted (calculated from create_time + [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
.google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getRetainExpireTimeOrBuilder()
Output only. The time at which this Backup will be automatically deleted (calculated from create_time + [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
.google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasEncryptionKey()
Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key] value.
.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
EncryptionKey getEncryptionKey()
Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key] value.
.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
EncryptionKeyOrBuilder getEncryptionKeyOrBuilder()
Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key] value.
.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasAllNamespaces()
Output only. If True, all namespaces were included in the Backup.
bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean getAllNamespaces()
Output only. If True, all namespaces were included in the Backup.
bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean hasSelectedNamespaces()
Output only. If set, the list of namespaces that were included in the Backup.
.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Namespaces getSelectedNamespaces()
Output only. If set, the list of namespaces that were included in the Backup.
.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
NamespacesOrBuilder getSelectedNamespacesOrBuilder()
Output only. If set, the list of namespaces that were included in the Backup.
.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasSelectedApplications()
Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
NamespacedNames getSelectedApplications()
Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
NamespacedNamesOrBuilder getSelectedApplicationsOrBuilder()
Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean getContainsVolumeData()
Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's [include_volume_data][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_volume_data] value.
bool contains_volume_data = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean getContainsSecrets()
Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's [include_secrets][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_secrets] value.
bool contains_secrets = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean hasClusterMetadata()
Output only. Information about the GKE cluster from which this Backup was created.
.google.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Backup.ClusterMetadata getClusterMetadata()
Output only. Information about the GKE cluster from which this Backup was created.
.google.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Backup.ClusterMetadataOrBuilder getClusterMetadataOrBuilder()
Output only. Information about the GKE cluster from which this Backup was created.
.google.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
int getStateValue()
Output only. Current state of the Backup
.google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Backup.State getState()
Output only. Current state of the Backup
.google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
String getStateReason()
Output only. Human-readable description of why the backup is in the current `state`.
string state_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getStateReasonBytes()
Output only. Human-readable description of why the backup is in the current `state`.
string state_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean hasCompleteTime()
Output only. Completion time of the Backup
.google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getCompleteTime()
Output only. Completion time of the Backup
.google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder()
Output only. Completion time of the Backup
.google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
int getResourceCount()
Output only. The total number of Kubernetes resources included in the Backup.
int32 resource_count = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];int getVolumeCount()
Output only. The total number of volume backups contained in the Backup.
int32 volume_count = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];long getSizeBytes()
Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
int64 size_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];String getEtag()
Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource.
string etag = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getEtagBytes()
Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource.
string etag = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];String getDescription()
User specified descriptive string for this Backup.
string description = 25;com.google.protobuf.ByteString getDescriptionBytes()
User specified descriptive string for this Backup.
string description = 25;int getPodCount()
Output only. The total number of Kubernetes Pods contained in the Backup.
int32 pod_count = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];long getConfigBackupSizeBytes()
Output only. The size of the config backup in bytes.
int64 config_backup_size_bytes = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];Backup.BackupScopeCase getBackupScopeCase()
Copyright © 2023 Google LLC. All rights reserved.