Class Backup (0.44.0)

Version 0.44.0

• 0.52.0 (latest)
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.6
• 0.1.0

public final class Backup extends GeneratedMessageV3 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).

Protobuf type google.cloud.gkebackup.v1.Backup

Inheritance

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

Implements

BackupOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALL_NAMESPACES_FIELD_NUMBER

public static final int ALL_NAMESPACES_FIELD_NUMBER

Field Value
Type	Description
int

CLUSTER_METADATA_FIELD_NUMBER

public static final int CLUSTER_METADATA_FIELD_NUMBER

Field Value
Type	Description
int

COMPLETE_TIME_FIELD_NUMBER

public static final int COMPLETE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

CONFIG_BACKUP_SIZE_BYTES_FIELD_NUMBER

public static final int CONFIG_BACKUP_SIZE_BYTES_FIELD_NUMBER

Field Value
Type	Description
int

CONTAINS_SECRETS_FIELD_NUMBER

public static final int CONTAINS_SECRETS_FIELD_NUMBER

Field Value
Type	Description
int

CONTAINS_VOLUME_DATA_FIELD_NUMBER

public static final int CONTAINS_VOLUME_DATA_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_LOCK_DAYS_FIELD_NUMBER

public static final int DELETE_LOCK_DAYS_FIELD_NUMBER

Field Value
Type	Description
int

DELETE_LOCK_EXPIRE_TIME_FIELD_NUMBER

public static final int DELETE_LOCK_EXPIRE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
int

ENCRYPTION_KEY_FIELD_NUMBER

public static final int ENCRYPTION_KEY_FIELD_NUMBER

Field Value
Type	Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

Field Value
Type	Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
int

MANUAL_FIELD_NUMBER

public static final int MANUAL_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

PERMISSIVE_MODE_FIELD_NUMBER

public static final int PERMISSIVE_MODE_FIELD_NUMBER

Field Value
Type	Description
int

POD_COUNT_FIELD_NUMBER

public static final int POD_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

RESOURCE_COUNT_FIELD_NUMBER

public static final int RESOURCE_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

RETAIN_DAYS_FIELD_NUMBER

public static final int RETAIN_DAYS_FIELD_NUMBER

Field Value
Type	Description
int

RETAIN_EXPIRE_TIME_FIELD_NUMBER

public static final int RETAIN_EXPIRE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

SELECTED_APPLICATIONS_FIELD_NUMBER

public static final int SELECTED_APPLICATIONS_FIELD_NUMBER

Field Value
Type	Description
int

SELECTED_NAMESPACES_FIELD_NUMBER

public static final int SELECTED_NAMESPACES_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

STATE_REASON_FIELD_NUMBER

public static final int STATE_REASON_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

VOLUME_COUNT_FIELD_NUMBER

public static final int VOLUME_COUNT_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()

Returns
Type	Description
Descriptor

newBuilder()

public static Backup.Builder newBuilder()

Returns
Type	Description
Backup.Builder

newBuilder(Backup prototype)

public static Backup.Builder newBuilder(Backup prototype)

Parameter
Name	Description
prototype	Backup

Returns
Type	Description
Backup.Builder

parseDelimitedFrom(InputStream input)

public static Backup parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Backup

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Backup

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Backup parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Backup

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Backup

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Backup parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Backup

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Backup

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Backup parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Backup

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Backup

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Backup parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Backup

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Backup

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Backup parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Backup

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Backup

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Backup> parser()

Returns
Type	Description
Parser<Backup>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAllNamespaces()

public 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 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.cloud.gkebackup.v1.Backup.ClusterMetadata cluster_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Backup.ClusterMetadata	The clusterMetadata.

getClusterMetadataOrBuilder()

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

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()

Returns
Type	Description
Backup

getDeleteLockDays()

public 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 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 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 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 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 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

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

getParserForType()

public Parser<Backup> getParserForType()

Returns
Type	Description
Parser<Backup>

Overrides

GeneratedMessageV3.getParserForType()

getPermissiveMode()

public boolean getPermissiveMode()

Output only. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

Inherited from the parent BackupPlan's permissive_mode value.

bool permissive_mode = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The permissiveMode.

getPodCount()

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The sizeBytes.

getState()

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

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Backup.Builder newBuilderForType()

Returns
Type	Description
Backup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Backup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Backup.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Backup.Builder toBuilder()

Returns
Type	Description
Backup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException