Interface BackupPlanOrBuilder

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

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

    • getName

      String getName()
       Output only. The full name of the BackupPlan resource.
       Format: `projects/*/locations/*/backupPlans/*`
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The full name of the BackupPlan resource.
       Format: `projects/*/locations/*/backupPlans/*`
       
      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
       [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
       
      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
       [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
       
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.
    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp when this BackupPlan 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 BackupPlan 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 BackupPlan resource was created.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The timestamp when this BackupPlan 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 BackupPlan 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 BackupPlan resource was last
       updated.
       
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getDescription

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

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

      String getCluster()
       Required. Immutable. The source cluster from which Backups will be created
       via this BackupPlan. Valid formats:
      
       - `projects/*/locations/*/clusters/*`
       - `projects/*/zones/*/clusters/*`
       
      string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The cluster.
    • getClusterBytes

      com.google.protobuf.ByteString getClusterBytes()
       Required. Immutable. The source cluster from which Backups will be created
       via this BackupPlan. Valid formats:
      
       - `projects/*/locations/*/clusters/*`
       - `projects/*/zones/*/clusters/*`
       
      string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for cluster.
    • hasRetentionPolicy

      boolean hasRetentionPolicy()
       Optional. RetentionPolicy governs lifecycle of Backups created under this
       plan.
       
      .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the retentionPolicy field is set.
    • getRetentionPolicy

      BackupPlan.RetentionPolicy getRetentionPolicy()
       Optional. RetentionPolicy governs lifecycle of Backups created under this
       plan.
       
      .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The retentionPolicy.
    • getRetentionPolicyOrBuilder

      BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()
       Optional. RetentionPolicy governs lifecycle of Backups created under this
       plan.
       
      .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsCount

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

      boolean containsLabels(String key)
       Optional. A set of custom labels supplied by user.
       
      map<string, string> labels = 8 [(.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 = 8 [(.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 = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsOrThrow

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

      boolean hasBackupSchedule()
       Optional. Defines a schedule for automatic Backup creation via this
       BackupPlan.
       
      .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the backupSchedule field is set.
    • getBackupSchedule

      BackupPlan.Schedule getBackupSchedule()
       Optional. Defines a schedule for automatic Backup creation via this
       BackupPlan.
       
      .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The backupSchedule.
    • getBackupScheduleOrBuilder

      BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder()
       Optional. Defines a schedule for automatic Backup creation via this
       BackupPlan.
       
      .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9 [(.google.api.field_behavior) = OPTIONAL];
    • getEtag

      String getEtag()
       Output only. `etag` is used for optimistic concurrency control as a way to
       help prevent simultaneous updates of a backup plan from overwriting each
       other. It is strongly suggested that systems make use of the 'etag' in the
       read-modify-write cycle to perform BackupPlan updates in order to avoid
       race conditions: An `etag` is returned in the response to `GetBackupPlan`,
       and systems are expected to put that etag in the request to
       `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
       will be applied to the same version of the resource.
       
      string etag = 10 [(.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 plan from overwriting each
       other. It is strongly suggested that systems make use of the 'etag' in the
       read-modify-write cycle to perform BackupPlan updates in order to avoid
       race conditions: An `etag` is returned in the response to `GetBackupPlan`,
       and systems are expected to put that etag in the request to
       `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
       will be applied to the same version of the resource.
       
      string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for etag.
    • getDeactivated

      boolean getDeactivated()
       Optional. This flag indicates whether this BackupPlan has been deactivated.
       Setting this field to True locks the BackupPlan such that no further
       updates will be allowed (except deletes), including the deactivated field
       itself. It also prevents any new Backups from being created via this
       BackupPlan (including scheduled Backups).
      
       Default: False
       
      bool deactivated = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The deactivated.
    • hasBackupConfig

      boolean hasBackupConfig()
       Optional. Defines the configuration of Backups created via this BackupPlan.
       
      .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the backupConfig field is set.
    • getBackupConfig

      BackupPlan.BackupConfig getBackupConfig()
       Optional. Defines the configuration of Backups created via this BackupPlan.
       
      .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The backupConfig.
    • getBackupConfigOrBuilder

      BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder()
       Optional. Defines the configuration of Backups created via this BackupPlan.
       
      .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12 [(.google.api.field_behavior) = OPTIONAL];
    • getProtectedPodCount

      int getProtectedPodCount()
       Output only. The number of Kubernetes Pods backed up in the
       last successful Backup created via this BackupPlan.
       
      int32 protected_pod_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The protectedPodCount.
    • getStateValue

      int getStateValue()
       Output only. State of the BackupPlan. This State field reflects the
       various stages a BackupPlan can be in
       during the Create operation. It will be set to "DEACTIVATED"
       if the BackupPlan is deactivated on an Update
       
      .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

      BackupPlan.State getState()
       Output only. State of the BackupPlan. This State field reflects the
       various stages a BackupPlan can be in
       during the Create operation. It will be set to "DEACTIVATED"
       if the BackupPlan is deactivated on an Update
       
      .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • getStateReason

      String getStateReason()
       Output only. Human-readable description of why BackupPlan 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 = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The stateReason.
    • getStateReasonBytes

      com.google.protobuf.ByteString getStateReasonBytes()
       Output only. Human-readable description of why BackupPlan 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 = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for stateReason.
    • getRpoRiskLevel

      int getRpoRiskLevel()
       Output only. A number that represents the current risk level of this
       BackupPlan from RPO perspective with 1 being no risk and 5 being highest
       risk.
       
      int32 rpo_risk_level = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The rpoRiskLevel.
    • getRpoRiskReason

      String getRpoRiskReason()
       Output only. Human-readable description of why the BackupPlan is in the
       current rpo_risk_level and action items if any.
       
      string rpo_risk_reason = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The rpoRiskReason.
    • getRpoRiskReasonBytes

      com.google.protobuf.ByteString getRpoRiskReasonBytes()
       Output only. Human-readable description of why the BackupPlan is in the
       current rpo_risk_level and action items if any.
       
      string rpo_risk_reason = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for rpoRiskReason.
    • getBackupChannel

      String getBackupChannel()
       Output only. The fully qualified name of the BackupChannel to be used to
       create a backup. This field is set only if the cluster being backed up is
       in a different project.
       `projects/*/locations/*/backupChannels/*`
       
      string backup_channel = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The backupChannel.
    • getBackupChannelBytes

      com.google.protobuf.ByteString getBackupChannelBytes()
       Output only. The fully qualified name of the BackupChannel to be used to
       create a backup. This field is set only if the cluster being backed up is
       in a different project.
       `projects/*/locations/*/backupChannels/*`
       
      string backup_channel = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for backupChannel.
    • hasLastSuccessfulBackupTime

      boolean hasLastSuccessfulBackupTime()
       Output only. Completion time of the last successful Backup. This is sourced
       from a successful Backup's complete_time field. This field is added to
       maintain consistency with BackupPlanBinding to display last successful
       backup time.
       
      .google.protobuf.Timestamp last_successful_backup_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the lastSuccessfulBackupTime field is set.
    • getLastSuccessfulBackupTime

      com.google.protobuf.Timestamp getLastSuccessfulBackupTime()
       Output only. Completion time of the last successful Backup. This is sourced
       from a successful Backup's complete_time field. This field is added to
       maintain consistency with BackupPlanBinding to display last successful
       backup time.
       
      .google.protobuf.Timestamp last_successful_backup_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The lastSuccessfulBackupTime.
    • getLastSuccessfulBackupTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getLastSuccessfulBackupTimeOrBuilder()
       Output only. Completion time of the last successful Backup. This is sourced
       from a successful Backup's complete_time field. This field is added to
       maintain consistency with BackupPlanBinding to display last successful
       backup time.
       
      .google.protobuf.Timestamp last_successful_backup_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];