Class Backup.Builder (0.15.0) 

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

Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). Next id: 28

Protobuf type google.events.cloud.gkebackup.v1.Backup

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Backup.Builder

Implements

BackupOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backup.Builder
Overrides

build()

public Backup build()
Returns
Type Description
Backup

buildPartial()

public Backup buildPartial()
Returns
Type Description
Backup

clear()

public Backup.Builder clear()
Returns
Type Description
Backup.Builder
Overrides

clearAllNamespaces()

public Backup.Builder clearAllNamespaces()

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

bool all_namespaces = 12;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearBackupScope()

public Backup.Builder clearBackupScope()
Returns
Type Description
Backup.Builder

clearClusterMetadata()

public Backup.Builder clearClusterMetadata()

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Returns
Type Description
Backup.Builder

clearCompleteTime()

public Backup.Builder clearCompleteTime()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Returns
Type Description
Backup.Builder

clearConfigBackupSizeBytes()

public Backup.Builder clearConfigBackupSizeBytes()

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

int64 config_backup_size_bytes = 27;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearContainsSecrets()

public Backup.Builder clearContainsSecrets()

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

bool contains_secrets = 16;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearContainsVolumeData()

public Backup.Builder clearContainsVolumeData()

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;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearCreateTime()

public Backup.Builder clearCreateTime()

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

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
Backup.Builder

clearDeleteLockDays()

public Backup.Builder clearDeleteLockDays()

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;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearDeleteLockExpireTime()

public Backup.Builder clearDeleteLockExpireTime()

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;

Returns
Type Description
Backup.Builder

clearDescription()

public Backup.Builder clearDescription()

User specified descriptive string for this Backup.

string description = 25;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearEncryptionKey()

public Backup.Builder clearEncryptionKey()

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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Returns
Type Description
Backup.Builder

clearEtag()

public Backup.Builder clearEtag()

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;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Backup.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Backup.Builder
Overrides

clearLabels()

public Backup.Builder clearLabels()
Returns
Type Description
Backup.Builder

clearManual()

public Backup.Builder clearManual()

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;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearName()

public Backup.Builder clearName()

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

string name = 1;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Backup.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Backup.Builder
Overrides

clearPodCount()

public Backup.Builder clearPodCount()

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

int32 pod_count = 26;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearResourceCount()

public Backup.Builder clearResourceCount()

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

int32 resource_count = 21;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearRetainDays()

public Backup.Builder clearRetainDays()

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;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearRetainExpireTime()

public Backup.Builder clearRetainExpireTime()

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;

Returns
Type Description
Backup.Builder

clearSelectedApplications()

public Backup.Builder clearSelectedApplications()

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Returns
Type Description
Backup.Builder

clearSelectedNamespaces()

public Backup.Builder clearSelectedNamespaces()

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Returns
Type Description
Backup.Builder

clearSizeBytes()

public Backup.Builder clearSizeBytes()

Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

int64 size_bytes = 23;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearState()

public Backup.Builder clearState()

Output only. Current state of the Backup

.google.events.cloud.gkebackup.v1.Backup.State state = 18;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearStateReason()

public Backup.Builder clearStateReason()

Output only. Human-readable description of why the backup is in the current state.

string state_reason = 19;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearUid()

public Backup.Builder clearUid()

Output only. Server generated global unique identifier of UUID4

string uid = 2;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearUpdateTime()

public Backup.Builder clearUpdateTime()

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Backup.Builder

clearVolumeCount()

public Backup.Builder clearVolumeCount()

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

int32 volume_count = 22;

Returns
Type Description
Backup.Builder

This builder for chaining.

clone()

public Backup.Builder clone()
Returns
Type Description
Backup.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAllNamespaces()

public boolean getAllNamespaces()

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

bool all_namespaces = 12;

Returns
Type Description
boolean

The allNamespaces.

getBackupScopeCase()

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

getClusterMetadata()

public Backup.ClusterMetadata getClusterMetadata()

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Returns
Type Description
Backup.ClusterMetadata

The clusterMetadata.

getClusterMetadataBuilder()

public Backup.ClusterMetadata.Builder getClusterMetadataBuilder()

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Returns
Type Description
Backup.ClusterMetadata.Builder

getClusterMetadataOrBuilder()

public Backup.ClusterMetadataOrBuilder getClusterMetadataOrBuilder()

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Returns
Type Description
Backup.ClusterMetadataOrBuilder

getCompleteTime()

public Timestamp getCompleteTime()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeBuilder()

public Timestamp.Builder getCompleteTimeBuilder()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Returns
Type Description
Builder

getCompleteTimeOrBuilder()

public TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Returns
Type Description
TimestampOrBuilder

getConfigBackupSizeBytes()

public long getConfigBackupSizeBytes()

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

int64 config_backup_size_bytes = 27;

Returns
Type Description
long

The configBackupSizeBytes.

getContainsSecrets()

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

Returns
Type Description
boolean

The containsSecrets.

getContainsVolumeData()

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

Returns
Type Description
boolean

The containsVolumeData.

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()
Returns
Type Description
Backup

getDeleteLockDays()

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

int32 delete_lock_days = 7;

Returns
Type Description
int

The deleteLockDays.

getDeleteLockExpireTime()

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

Returns
Type Description
Timestamp

The deleteLockExpireTime.

getDeleteLockExpireTimeBuilder()

public Timestamp.Builder getDeleteLockExpireTimeBuilder()

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;

Returns
Type Description
Builder

getDeleteLockExpireTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getDescription()

public String getDescription()

User specified descriptive string for this Backup.

string description = 25;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User specified descriptive string for this Backup.

string description = 25;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEncryptionKey()

public 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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Returns
Type Description
EncryptionKey

The encryptionKey.

getEncryptionKeyBuilder()

public EncryptionKey.Builder getEncryptionKeyBuilder()

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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Returns
Type Description
EncryptionKey.Builder

getEncryptionKeyOrBuilder()

public 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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Returns
Type Description
EncryptionKeyOrBuilder

getEtag()

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

Returns
Type Description
String

The etag.

getEtagBytes()

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

Returns
Type Description
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

A set of custom labels supplied by user.

map<string, string> labels = 6;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

A set of custom labels supplied by user.

map<string, string> labels = 6;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

A set of custom labels supplied by user.

map<string, string> labels = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

A set of custom labels supplied by user.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getManual()

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

Returns
Type Description
boolean

The manual.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPodCount()

public int getPodCount()

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

int32 pod_count = 26;

Returns
Type Description
int

The podCount.

getResourceCount()

public int getResourceCount()

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

int32 resource_count = 21;

Returns
Type Description
int

The resourceCount.

getRetainDays()

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

Returns
Type Description
int

The retainDays.

getRetainExpireTime()

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

Returns
Type Description
Timestamp

The retainExpireTime.

getRetainExpireTimeBuilder()

public Timestamp.Builder getRetainExpireTimeBuilder()

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;

Returns
Type Description
Builder

getRetainExpireTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getSelectedApplications()

public NamespacedNames getSelectedApplications()

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Returns
Type Description
NamespacedNames

The selectedApplications.

getSelectedApplicationsBuilder()

public NamespacedNames.Builder getSelectedApplicationsBuilder()

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Returns
Type Description
NamespacedNames.Builder

getSelectedApplicationsOrBuilder()

public NamespacedNamesOrBuilder getSelectedApplicationsOrBuilder()

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Returns
Type Description
NamespacedNamesOrBuilder

getSelectedNamespaces()

public Namespaces getSelectedNamespaces()

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Returns
Type Description
Namespaces

The selectedNamespaces.

getSelectedNamespacesBuilder()

public Namespaces.Builder getSelectedNamespacesBuilder()

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Returns
Type Description
Namespaces.Builder

getSelectedNamespacesOrBuilder()

public NamespacesOrBuilder getSelectedNamespacesOrBuilder()

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Returns
Type Description
NamespacesOrBuilder

getSizeBytes()

public long getSizeBytes()

Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

int64 size_bytes = 23;

Returns
Type Description
long

The sizeBytes.

getState()

public Backup.State getState()

Output only. Current state of the Backup

.google.events.cloud.gkebackup.v1.Backup.State state = 18;

Returns
Type Description
Backup.State

The state.

getStateReason()

public String getStateReason()

Output only. Human-readable description of why the backup is in the current state.

string state_reason = 19;

Returns
Type Description
String

The stateReason.

getStateReasonBytes()

public ByteString getStateReasonBytes()

Output only. Human-readable description of why the backup is in the current state.

string state_reason = 19;

Returns
Type Description
ByteString

The bytes for stateReason.

getStateValue()

public int getStateValue()

Output only. Current state of the Backup

.google.events.cloud.gkebackup.v1.Backup.State state = 18;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. Server generated global unique identifier of UUID4

string uid = 2;

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Server generated global unique identifier of UUID4

string uid = 2;

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
TimestampOrBuilder

getVolumeCount()

public int getVolumeCount()

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

int32 volume_count = 22;

Returns
Type Description
int

The volumeCount.

hasAllNamespaces()

public boolean hasAllNamespaces()

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

bool all_namespaces = 12;

Returns
Type Description
boolean

Whether the allNamespaces field is set.

hasClusterMetadata()

public boolean hasClusterMetadata()

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Returns
Type Description
boolean

Whether the clusterMetadata field is set.

hasCompleteTime()

public boolean hasCompleteTime()

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Returns
Type Description
boolean

Whether the completeTime field is set.

hasCreateTime()

public boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteLockExpireTime()

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

Returns
Type Description
boolean

Whether the deleteLockExpireTime field is set.

hasEncryptionKey()

public 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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Returns
Type Description
boolean

Whether the encryptionKey field is set.

hasRetainExpireTime()

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

Returns
Type Description
boolean

Whether the retainExpireTime field is set.

hasSelectedApplications()

public boolean hasSelectedApplications()

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Returns
Type Description
boolean

Whether the selectedApplications field is set.

hasSelectedNamespaces()

public boolean hasSelectedNamespaces()

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Returns
Type Description
boolean

Whether the selectedNamespaces field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeClusterMetadata(Backup.ClusterMetadata value)

public Backup.Builder mergeClusterMetadata(Backup.ClusterMetadata value)

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Parameter
Name Description
value Backup.ClusterMetadata
Returns
Type Description
Backup.Builder

mergeCompleteTime(Timestamp value)

public Backup.Builder mergeCompleteTime(Timestamp value)

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

mergeCreateTime(Timestamp value)

public Backup.Builder mergeCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

mergeDeleteLockExpireTime(Timestamp value)

public Backup.Builder mergeDeleteLockExpireTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

mergeEncryptionKey(EncryptionKey value)

public Backup.Builder mergeEncryptionKey(EncryptionKey value)

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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Parameter
Name Description
value EncryptionKey
Returns
Type Description
Backup.Builder

mergeFrom(Backup other)

public Backup.Builder mergeFrom(Backup other)
Parameter
Name Description
other Backup
Returns
Type Description
Backup.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Backup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Backup.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Backup.Builder
Overrides

mergeRetainExpireTime(Timestamp value)

public Backup.Builder mergeRetainExpireTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

mergeSelectedApplications(NamespacedNames value)

public Backup.Builder mergeSelectedApplications(NamespacedNames value)

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Parameter
Name Description
value NamespacedNames
Returns
Type Description
Backup.Builder

mergeSelectedNamespaces(Namespaces value)

public Backup.Builder mergeSelectedNamespaces(Namespaces value)

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Parameter
Name Description
value Namespaces
Returns
Type Description
Backup.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backup.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Backup.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

putAllLabels(Map<String,String> values)

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

A set of custom labels supplied by user.

map<string, string> labels = 6;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Backup.Builder

putLabels(String key, String value)

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

A set of custom labels supplied by user.

map<string, string> labels = 6;

Parameters
Name Description
key String
value String
Returns
Type Description
Backup.Builder

removeLabels(String key)

public Backup.Builder removeLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
Backup.Builder

setAllNamespaces(boolean value)

public Backup.Builder setAllNamespaces(boolean value)

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

bool all_namespaces = 12;

Parameter
Name Description
value boolean

The allNamespaces to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setClusterMetadata(Backup.ClusterMetadata value)

public Backup.Builder setClusterMetadata(Backup.ClusterMetadata value)

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Parameter
Name Description
value Backup.ClusterMetadata
Returns
Type Description
Backup.Builder

setClusterMetadata(Backup.ClusterMetadata.Builder builderForValue)

public Backup.Builder setClusterMetadata(Backup.ClusterMetadata.Builder builderForValue)

Output only. Information about the GKE cluster from which this Backup was created.

.google.events.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17;

Parameter
Name Description
builderForValue Backup.ClusterMetadata.Builder
Returns
Type Description
Backup.Builder

setCompleteTime(Timestamp value)

public Backup.Builder setCompleteTime(Timestamp value)

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

setCompleteTime(Timestamp.Builder builderForValue)

public Backup.Builder setCompleteTime(Timestamp.Builder builderForValue)

Output only. Completion time of the Backup

.google.protobuf.Timestamp complete_time = 20;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setConfigBackupSizeBytes(long value)

public Backup.Builder setConfigBackupSizeBytes(long value)

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

int64 config_backup_size_bytes = 27;

Parameter
Name Description
value long

The configBackupSizeBytes to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setContainsSecrets(boolean value)

public Backup.Builder setContainsSecrets(boolean value)

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

bool contains_secrets = 16;

Parameter
Name Description
value boolean

The containsSecrets to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setContainsVolumeData(boolean value)

public Backup.Builder setContainsVolumeData(boolean value)

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;

Parameter
Name Description
value boolean

The containsVolumeData to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Backup.Builder setCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Backup.Builder setCreateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp create_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setDeleteLockDays(int value)

public Backup.Builder setDeleteLockDays(int value)

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;

Parameter
Name Description
value int

The deleteLockDays to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setDeleteLockExpireTime(Timestamp value)

public Backup.Builder setDeleteLockExpireTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

setDeleteLockExpireTime(Timestamp.Builder builderForValue)

public Backup.Builder setDeleteLockExpireTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setDescription(String value)

public Backup.Builder setDescription(String value)

User specified descriptive string for this Backup.

string description = 25;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Backup.Builder setDescriptionBytes(ByteString value)

User specified descriptive string for this Backup.

string description = 25;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setEncryptionKey(EncryptionKey value)

public Backup.Builder setEncryptionKey(EncryptionKey value)

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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Parameter
Name Description
value EncryptionKey
Returns
Type Description
Backup.Builder

setEncryptionKey(EncryptionKey.Builder builderForValue)

public Backup.Builder setEncryptionKey(EncryptionKey.Builder builderForValue)

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.events.cloud.gkebackup.v1.EncryptionKey encryption_key = 11;

Parameter
Name Description
builderForValue EncryptionKey.Builder
Returns
Type Description
Backup.Builder

setEtag(String value)

public Backup.Builder setEtag(String value)

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;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Backup.Builder setEtagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backup.Builder
Overrides

setManual(boolean value)

public Backup.Builder setManual(boolean value)

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;

Parameter
Name Description
value boolean

The manual to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setName(String value)

public Backup.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Backup.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setPodCount(int value)

public Backup.Builder setPodCount(int value)

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

int32 pod_count = 26;

Parameter
Name Description
value int

The podCount to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Backup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Backup.Builder
Overrides

setResourceCount(int value)

public Backup.Builder setResourceCount(int value)

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

int32 resource_count = 21;

Parameter
Name Description
value int

The resourceCount to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setRetainDays(int value)

public Backup.Builder setRetainDays(int value)

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;

Parameter
Name Description
value int

The retainDays to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setRetainExpireTime(Timestamp value)

public Backup.Builder setRetainExpireTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

setRetainExpireTime(Timestamp.Builder builderForValue)

public Backup.Builder setRetainExpireTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setSelectedApplications(NamespacedNames value)

public Backup.Builder setSelectedApplications(NamespacedNames value)

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Parameter
Name Description
value NamespacedNames
Returns
Type Description
Backup.Builder

setSelectedApplications(NamespacedNames.Builder builderForValue)

public Backup.Builder setSelectedApplications(NamespacedNames.Builder builderForValue)

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

.google.events.cloud.gkebackup.v1.NamespacedNames selected_applications = 14;

Parameter
Name Description
builderForValue NamespacedNames.Builder
Returns
Type Description
Backup.Builder

setSelectedNamespaces(Namespaces value)

public Backup.Builder setSelectedNamespaces(Namespaces value)

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Parameter
Name Description
value Namespaces
Returns
Type Description
Backup.Builder

setSelectedNamespaces(Namespaces.Builder builderForValue)

public Backup.Builder setSelectedNamespaces(Namespaces.Builder builderForValue)

Output only. If set, the list of namespaces that were included in the Backup.

.google.events.cloud.gkebackup.v1.Namespaces selected_namespaces = 13;

Parameter
Name Description
builderForValue Namespaces.Builder
Returns
Type Description
Backup.Builder

setSizeBytes(long value)

public Backup.Builder setSizeBytes(long value)

Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

int64 size_bytes = 23;

Parameter
Name Description
value long

The sizeBytes to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setState(Backup.State value)

public Backup.Builder setState(Backup.State value)

Output only. Current state of the Backup

.google.events.cloud.gkebackup.v1.Backup.State state = 18;

Parameter
Name Description
value Backup.State

The state to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setStateReason(String value)

public Backup.Builder setStateReason(String value)

Output only. Human-readable description of why the backup is in the current state.

string state_reason = 19;

Parameter
Name Description
value String

The stateReason to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setStateReasonBytes(ByteString value)

public Backup.Builder setStateReasonBytes(ByteString value)

Output only. Human-readable description of why the backup is in the current state.

string state_reason = 19;

Parameter
Name Description
value ByteString

The bytes for stateReason to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setStateValue(int value)

public Backup.Builder setStateValue(int value)

Output only. Current state of the Backup

.google.events.cloud.gkebackup.v1.Backup.State state = 18;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setUid(String value)

public Backup.Builder setUid(String value)

Output only. Server generated global unique identifier of UUID4

string uid = 2;

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Backup.Builder setUidBytes(ByteString value)

Output only. Server generated global unique identifier of UUID4

string uid = 2;

Parameter
Name Description
value ByteString

The bytes for uid to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backup.Builder
Overrides

setUpdateTime(Timestamp value)

public Backup.Builder setUpdateTime(Timestamp value)

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Backup.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when this Backup resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setVolumeCount(int value)

public Backup.Builder setVolumeCount(int value)

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

int32 volume_count = 22;

Parameter
Name Description
value int

The volumeCount to set.
Returns
Type Description
Backup.Builder

This builder for chaining.