com.google.cloud.gkebackup.v1.BackupOrBuilder Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/gkebackup/v1/backup.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.gkebackup.v1;
public interface BackupOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.gkebackup.v1.Backup)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The fully qualified name of the Backup.
* `projects/*/locations/*/backupPlans/*/backups/*`
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The fully qualified name of the Backup.
* `projects/*/locations/*/backupPlans/*/backups/*`
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Server generated global unique identifier of
* [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. Server generated global unique identifier of
* [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. The timestamp when this Backup resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The timestamp when this Backup resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The timestamp when this Backup resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The timestamp when this Backup resource was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
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];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The timestamp when this Backup resource was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. 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];
*
* @return The manual.
*/
boolean getManual();
/**
*
*
*
* Optional. A set of custom labels supplied by user.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. A set of custom labels supplied by user.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. A set of custom labels supplied by user.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. A set of custom labels supplied by user.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. A set of custom labels supplied by user.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* 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][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days]
* setting and may only be increased
* (either at creation time or in a subsequent update).
*
*
* int32 delete_lock_days = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The deleteLockDays.
*/
int getDeleteLockDays();
/**
*
*
*
* Output only. The time at which an existing delete lock will expire for this
* backup (calculated from create_time +
* [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
*
*
*
* .google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deleteLockExpireTime field is set.
*/
boolean hasDeleteLockExpireTime();
/**
*
*
*
* Output only. The time at which an existing delete lock will expire for this
* backup (calculated from create_time +
* [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
*
*
*
* .google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The deleteLockExpireTime.
*/
com.google.protobuf.Timestamp getDeleteLockExpireTime();
/**
*
*
*
* Output only. The time at which an existing delete lock will expire for this
* backup (calculated from create_time +
* [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
*
*
*
* .google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getDeleteLockExpireTimeOrBuilder();
/**
*
*
*
* 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][google.cloud.gkebackup.v1.Backup.delete_lock_days] and
* <= 365.
*
* Once a Backup is created, this value may only be increased.
*
* Defaults to the parent BackupPlan's
* [backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days]
* value.
*
*
* int32 retain_days = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The retainDays.
*/
int getRetainDays();
/**
*
*
*
* Output only. The time at which this Backup will be automatically deleted
* (calculated from create_time +
* [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
*
*
*
* .google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the retainExpireTime field is set.
*/
boolean hasRetainExpireTime();
/**
*
*
*
* Output only. The time at which this Backup will be automatically deleted
* (calculated from create_time +
* [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
*
*
*
* .google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The retainExpireTime.
*/
com.google.protobuf.Timestamp getRetainExpireTime();
/**
*
*
*
* Output only. The time at which this Backup will be automatically deleted
* (calculated from create_time +
* [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
*
*
*
* .google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getRetainExpireTimeOrBuilder();
/**
*
*
*
* Output only. The customer managed encryption key that was used to encrypt
* the Backup's artifacts. Inherited from the parent BackupPlan's
* [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key]
* value.
*
*
*
* .google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the encryptionKey field is set.
*/
boolean hasEncryptionKey();
/**
*
*
*
* Output only. The customer managed encryption key that was used to encrypt
* the Backup's artifacts. Inherited from the parent BackupPlan's
* [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key]
* value.
*
*
*
* .google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The encryptionKey.
*/
com.google.cloud.gkebackup.v1.EncryptionKey getEncryptionKey();
/**
*
*
*
* Output only. The customer managed encryption key that was used to encrypt
* the Backup's artifacts. Inherited from the parent BackupPlan's
* [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key]
* value.
*
*
*
* .google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.gkebackup.v1.EncryptionKeyOrBuilder getEncryptionKeyOrBuilder();
/**
*
*
*
* Output only. If True, all namespaces were included in the Backup.
*
*
* bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return Whether the allNamespaces field is set.
*/
boolean hasAllNamespaces();
/**
*
*
*
* Output only. If True, all namespaces were included in the Backup.
*
*
* bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The allNamespaces.
*/
boolean getAllNamespaces();
/**
*
*
*
* 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];
*
*
* @return Whether the selectedNamespaces field is set.
*/
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];
*
*
* @return The selectedNamespaces.
*/
com.google.cloud.gkebackup.v1.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];
*
*/
com.google.cloud.gkebackup.v1.NamespacesOrBuilder getSelectedNamespacesOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the selectedApplications field is set.
*/
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];
*
*
* @return The selectedApplications.
*/
com.google.cloud.gkebackup.v1.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];
*
*/
com.google.cloud.gkebackup.v1.NamespacedNamesOrBuilder getSelectedApplicationsOrBuilder();
/**
*
*
*
* Output only. Whether or not the Backup contains volume data. Controlled by
* the parent BackupPlan's
* [include_volume_data][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_volume_data]
* value.
*
*
* bool contains_volume_data = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The containsVolumeData.
*/
boolean getContainsVolumeData();
/**
*
*
*
* Output only. Whether or not the Backup contains Kubernetes Secrets.
* Controlled by the parent BackupPlan's
* [include_secrets][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_secrets]
* value.
*
*
* bool contains_secrets = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The containsSecrets.
*/
boolean getContainsSecrets();
/**
*
*
*
* 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];
*
*
* @return Whether the clusterMetadata field is set.
*/
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];
*
*
* @return The clusterMetadata.
*/
com.google.cloud.gkebackup.v1.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];
*
*/
com.google.cloud.gkebackup.v1.Backup.ClusterMetadataOrBuilder getClusterMetadataOrBuilder();
/**
*
*
*
* Output only. Current state of the Backup
*
*
*
* .google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. Current state of the Backup
*
*
*
* .google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.gkebackup.v1.Backup.State getState();
/**
*
*
*
* Output only. Human-readable description of why the backup is in the current
* `state`.
*
*
* string state_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The stateReason.
*/
java.lang.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];
*
* @return The bytes for stateReason.
*/
com.google.protobuf.ByteString getStateReasonBytes();
/**
*
*
*
* Output only. Completion time of the Backup
*
*
*
* .google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the completeTime field is set.
*/
boolean hasCompleteTime();
/**
*
*
*
* Output only. Completion time of the Backup
*
*
*
* .google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The completeTime.
*/
com.google.protobuf.Timestamp getCompleteTime();
/**
*
*
*
* Output only. Completion time of the Backup
*
*
*
* .google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder();
/**
*
*
*
* Output only. The total number of Kubernetes resources included in the
* Backup.
*
*
* int32 resource_count = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The resourceCount.
*/
int getResourceCount();
/**
*
*
*
* Output only. The total number of volume backups contained in the Backup.
*
*
* int32 volume_count = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The volumeCount.
*/
int getVolumeCount();
/**
*
*
*
* 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];
*
* @return The sizeBytes.
*/
long getSizeBytes();
/**
*
*
*
* 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];
*
* @return The etag.
*/
java.lang.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];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Optional. User specified descriptive string for this Backup.
*
*
* string description = 25 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. User specified descriptive string for this Backup.
*
*
* string description = 25 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Output only. The total number of Kubernetes Pods contained in the Backup.
*
*
* int32 pod_count = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The podCount.
*/
int getPodCount();
/**
*
*
*
* Output only. The size of the config backup in bytes.
*
*
* int64 config_backup_size_bytes = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The configBackupSizeBytes.
*/
long getConfigBackupSizeBytes();
/**
*
*
*
* 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][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.permissive_mode]
* value.
*
*
* bool permissive_mode = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The permissiveMode.
*/
boolean getPermissiveMode();
com.google.cloud.gkebackup.v1.Backup.BackupScopeCase getBackupScopeCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy