Package com.google.cloud.gkebackup.v1

Interface BackupPlanOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    BackupPlan, BackupPlan.Builder
    public interface BackupPlanOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • 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()
         User specified descriptive string for this BackupPlan.
        string description = 5;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         User specified descriptive string for this BackupPlan.
        string description = 5;
        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()
         RetentionPolicy governs lifecycle of Backups created under this plan.
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
        Returns:
        Whether the retentionPolicy field is set.

      • getRetentionPolicy

        BackupPlan.RetentionPolicy getRetentionPolicy()
         RetentionPolicy governs lifecycle of Backups created under this plan.
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
        Returns:
        The retentionPolicy.

      • getRetentionPolicyOrBuilder

        BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()
         RetentionPolicy governs lifecycle of Backups created under this plan.
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;

      • getLabelsCount

        int getLabelsCount()
         A set of custom labels supplied by user.
        map<string, string> labels = 8;

      • containsLabels

        boolean containsLabels​(String key)
         A set of custom labels supplied by user.
        map<string, string> labels = 8;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         A set of custom labels supplied by user.
        map<string, string> labels = 8;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         A set of custom labels supplied by user.
        map<string, string> labels = 8;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         A set of custom labels supplied by user.
        map<string, string> labels = 8;

      • hasBackupSchedule

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

      • getBackupSchedule

        BackupPlan.Schedule getBackupSchedule()
         Defines a schedule for automatic Backup creation via this BackupPlan.
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
        Returns:
        The backupSchedule.

      • getBackupScheduleOrBuilder

        BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder()
         Defines a schedule for automatic Backup creation via this BackupPlan.
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;

      • 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()
         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;
        Returns:
        The deactivated.

      • hasBackupConfig

        boolean hasBackupConfig()
         Defines the configuration of Backups created via this BackupPlan.
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
        Returns:
        Whether the backupConfig field is set.

      • getBackupConfig

        BackupPlan.BackupConfig getBackupConfig()
         Defines the configuration of Backups created via this BackupPlan.
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
        Returns:
        The backupConfig.

      • getBackupConfigOrBuilder

        BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder()
         Defines the configuration of Backups created via this BackupPlan.
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;

      • 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`
        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`
        string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for stateReason.