Interface BackupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Backup, Backup.Builder

@Generated public interface BackupOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      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:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The fully qualified name of the Backup.
       `projects/*/locations/*/backupPlans/*/backups/*`
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.
    • getUid

      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];
      Returns:
      The uid.
    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. Server generated global unique identifier of
       [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
       
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.
    • hasCreateTime

      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:
      Whether the createTime field is set.
    • getCreateTime

      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];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when this Backup resource was created.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      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:
      Whether the updateTime field is set.
    • getUpdateTime

      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];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp when this Backup resource was last updated.
       
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getManual

      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:
      The manual.
    • getLabelsCount

      int getLabelsCount()
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
    • containsLabels

      boolean containsLabels(String key)
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsOrDefault

      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];
    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getDeleteLockDays

      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][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];
      Returns:
      The deleteLockDays.
    • hasDeleteLockExpireTime

      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];
      Returns:
      Whether the deleteLockExpireTime field is set.
    • getDeleteLockExpireTime

      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];
      Returns:
      The deleteLockExpireTime.
    • getDeleteLockExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getDeleteLockExpireTimeOrBuilder()
       Output only. The time at which an existing delete lock will expire for this
       backup (calculated from create_time +
       [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).
       
      .google.protobuf.Timestamp delete_lock_expire_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getRetainDays

      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][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];
      Returns:
      The retainDays.
    • hasRetainExpireTime

      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];
      Returns:
      Whether the retainExpireTime field is set.
    • getRetainExpireTime

      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];
      Returns:
      The retainExpireTime.
    • getRetainExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getRetainExpireTimeOrBuilder()
       Output only. The time at which this Backup will be automatically deleted
       (calculated from create_time +
       [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).
       
      .google.protobuf.Timestamp retain_expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasEncryptionKey

      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];
      Returns:
      Whether the encryptionKey field is set.
    • getEncryptionKey

      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];
      Returns:
      The encryptionKey.
    • getEncryptionKeyOrBuilder

      EncryptionKeyOrBuilder getEncryptionKeyOrBuilder()
       Output only. The customer managed encryption key that was used to encrypt
       the Backup's artifacts.  Inherited from the parent BackupPlan's
       [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key]
       value.
       
      .google.cloud.gkebackup.v1.EncryptionKey encryption_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasAllNamespaces

      boolean hasAllNamespaces()
       Output only. If True, all namespaces were included in the Backup.
       
      bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the allNamespaces field is set.
    • getAllNamespaces

      boolean getAllNamespaces()
       Output only. If True, all namespaces were included in the Backup.
       
      bool all_namespaces = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The allNamespaces.
    • hasSelectedNamespaces

      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:
      Whether the selectedNamespaces field is set.
    • getSelectedNamespaces

      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:
      The selectedNamespaces.
    • getSelectedNamespacesOrBuilder

      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];
    • hasSelectedApplications

      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:
      Whether the selectedApplications field is set.
    • getSelectedApplications

      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:
      The selectedApplications.
    • getSelectedApplicationsOrBuilder

      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];
    • getContainsVolumeData

      boolean getContainsVolumeData()
       Output only. Whether or not the Backup contains volume data.  Controlled by
       the parent BackupPlan's
       [include_volume_data][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_volume_data]
       value.
       
      bool contains_volume_data = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The containsVolumeData.
    • getContainsSecrets

      boolean getContainsSecrets()
       Output only. Whether or not the Backup contains Kubernetes Secrets.
       Controlled by the parent BackupPlan's
       [include_secrets][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_secrets]
       value.
       
      bool contains_secrets = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The containsSecrets.
    • hasClusterMetadata

      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:
      Whether the clusterMetadata field is set.
    • getClusterMetadata

      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:
      The clusterMetadata.
    • getClusterMetadataOrBuilder

      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];
    • getStateValue

      int getStateValue()
       Output only. Current state of the Backup
       
      .google.cloud.gkebackup.v1.Backup.State state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

      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:
      The state.
    • getStateReason

      String getStateReason()
       Output only. Human-readable description of why the backup is in the current
       `state`. This field is only meant for human readability and should not be
       used programmatically as this field is not guaranteed to be consistent.
       
      string state_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The stateReason.
    • getStateReasonBytes

      com.google.protobuf.ByteString getStateReasonBytes()
       Output only. Human-readable description of why the backup is in the current
       `state`. This field is only meant for human readability and should not be
       used programmatically as this field is not guaranteed to be consistent.
       
      string state_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for stateReason.
    • hasCompleteTime

      boolean hasCompleteTime()
       Output only. Completion time of the Backup
       
      .google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the completeTime field is set.
    • getCompleteTime

      com.google.protobuf.Timestamp getCompleteTime()
       Output only. Completion time of the Backup
       
      .google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The completeTime.
    • getCompleteTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder()
       Output only. Completion time of the Backup
       
      .google.protobuf.Timestamp complete_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getResourceCount

      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:
      The resourceCount.
    • getVolumeCount

      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:
      The volumeCount.
    • getSizeBytes

      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:
      The sizeBytes.
    • getEtag

      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:
      The etag.
    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       Output only. `etag` is used for optimistic concurrency control as a way to
       help prevent simultaneous updates of a backup from overwriting each other.
       It is strongly suggested that systems make use of the `etag` in the
       read-modify-write cycle to perform backup updates in order to avoid
       race conditions: An `etag` is returned in the response to `GetBackup`,
       and systems are expected to put that etag in the request to
       `UpdateBackup` or `DeleteBackup` to ensure that their change will be
       applied to the same version of the resource.
       
      string etag = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for etag.
    • getDescription

      String getDescription()
       Optional. User specified descriptive string for this Backup.
       
      string description = 25 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. User specified descriptive string for this Backup.
       
      string description = 25 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.
    • getPodCount

      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:
      The podCount.
    • getConfigBackupSizeBytes

      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:
      The configBackupSizeBytes.
    • getPermissiveMode

      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][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.permissive_mode]
       value.
       
      bool permissive_mode = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The permissiveMode.
    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. [Output Only] Reserved for future use.
       
      bool satisfies_pzs = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzs.
    • getSatisfiesPzi

      boolean getSatisfiesPzi()
       Output only. [Output Only] Reserved for future use.
       
      bool satisfies_pzi = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzi.
    • getBackupScopeCase

      Backup.BackupScopeCase getBackupScopeCase()