Interface BackupOrBuilder (0.42.0) 

public interface BackupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAllNamespaces()

public abstract boolean getAllNamespaces()

Output only. If True, all namespaces were included in the Backup.

bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The allNamespaces.

getBackupScopeCase()

public abstract Backup.BackupScopeCase getBackupScopeCase()
Returns
Type Description
Backup.BackupScopeCase

getClusterMetadata()

public abstract 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];

Returns
Type Description
Backup.ClusterMetadata

The clusterMetadata.

getClusterMetadataOrBuilder()

public abstract 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];

Returns
Type Description
Backup.ClusterMetadataOrBuilder

getCompleteTime()

public abstract Timestamp getCompleteTime()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeOrBuilder()

public abstract TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getConfigBackupSizeBytes()

public abstract long getConfigBackupSizeBytes()

Output only. The size of the config backup in bytes.

int64 config_backup_size_bytes = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The configBackupSizeBytes.

getContainsSecrets()

public abstract boolean getContainsSecrets()

Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.

bool contains_secrets = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The containsSecrets.

getContainsVolumeData()

public abstract boolean getContainsVolumeData()

Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.

bool contains_volume_data = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The containsVolumeData.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp when this Backup resource was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when this Backup resource was created.

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

Returns
Type Description
TimestampOrBuilder

getDeleteLockDays()

public abstract int getDeleteLockDays()

Optional. 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 setting and may only be increased (either at creation time or in a subsequent update).

int32 delete_lock_days = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The deleteLockDays.

getDeleteLockExpireTime()

public abstract 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.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteLockExpireTime.

getDeleteLockExpireTimeOrBuilder()

public abstract 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.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. User specified descriptive string for this Backup.

string description = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. User specified descriptive string for this Backup.

string description = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEncryptionKey()

public abstract 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 value.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionKey

The encryptionKey.

getEncryptionKeyOrBuilder()

public abstract 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 value.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionKeyOrBuilder

getEtag()

public abstract 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];

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract 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];

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getManual()

public abstract 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];

Returns
Type Description
boolean

The manual.

getName()

public abstract String getName()

Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

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

Returns
Type Description
ByteString

The bytes for name.

getPodCount()

public abstract int getPodCount()

Output only. The total number of Kubernetes Pods contained in the Backup.

int32 pod_count = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The podCount.

getResourceCount()

public abstract int getResourceCount()

Output only. The total number of Kubernetes resources included in the Backup.

int32 resource_count = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The resourceCount.

getRetainDays()

public abstract int getRetainDays()

Optional. 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 and <= 365.

    Once a Backup is created, this value may only be increased.

    Defaults to the parent BackupPlan's backup_retain_days value.

int32 retain_days = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The retainDays.

getRetainExpireTime()

public abstract Timestamp getRetainExpireTime()

Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

.google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The retainExpireTime.

getRetainExpireTimeOrBuilder()

public abstract TimestampOrBuilder getRetainExpireTimeOrBuilder()

Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

.google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getSelectedApplications()

public abstract 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];

Returns
Type Description
NamespacedNames

The selectedApplications.

getSelectedApplicationsOrBuilder()

public abstract 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];

Returns
Type Description
NamespacedNamesOrBuilder

getSelectedNamespaces()

public abstract 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];

Returns
Type Description
Namespaces

The selectedNamespaces.

getSelectedNamespacesOrBuilder()

public abstract 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];

Returns
Type Description
NamespacesOrBuilder

getSizeBytes()

public abstract 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];

Returns
Type Description
long

The sizeBytes.

getState()

public abstract Backup.State getState()

Output only. Current state of the Backup

.google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.State

The state.

getStateReason()

public abstract 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];

Returns
Type Description
String

The stateReason.

getStateReasonBytes()

public abstract 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];

Returns
Type Description
ByteString

The bytes for stateReason.

getStateValue()

public abstract int getStateValue()

Output only. Current state of the Backup

.google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public abstract String getUid()

Output only. Server generated global unique identifier of UUID4

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

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Server generated global unique identifier of UUID4

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

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public abstract 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];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract 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];

Returns
Type Description
TimestampOrBuilder

getVolumeCount()

public abstract int getVolumeCount()

Output only. The total number of volume backups contained in the Backup.

int32 volume_count = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The volumeCount.

hasAllNamespaces()

public abstract boolean hasAllNamespaces()

Output only. If True, all namespaces were included in the Backup.

bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the allNamespaces field is set.

hasClusterMetadata()

public abstract 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];

Returns
Type Description
boolean

Whether the clusterMetadata field is set.

hasCompleteTime()

public abstract boolean hasCompleteTime()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the completeTime field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp when this Backup resource was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteLockExpireTime()

public abstract 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.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteLockExpireTime field is set.

hasEncryptionKey()

public abstract 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 value.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the encryptionKey field is set.

hasRetainExpireTime()

public abstract boolean hasRetainExpireTime()

Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

.google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the retainExpireTime field is set.

hasSelectedApplications()

public abstract 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];

Returns
Type Description
boolean

Whether the selectedApplications field is set.

hasSelectedNamespaces()

public abstract 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];

Returns
Type Description
boolean

Whether the selectedNamespaces field is set.

hasUpdateTime()

public abstract 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];

Returns
Type Description
boolean

Whether the updateTime field is set.