Package com.google.cloud.gkebackup.v1

Interface RestorePlanOrBuilder

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

    • Method Detail

      • getName

        String getName()
         Output only. The full name of the RestorePlan resource.
 Format: `projects/*/locations/*/restorePlans/*`.
        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 RestorePlan resource.
 Format: `projects/*/locations/*/restorePlans/*`.
        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 RestorePlan 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 RestorePlan 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 RestorePlan resource was
 created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The timestamp when this RestorePlan 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 RestorePlan 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 RestorePlan 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 RestorePlan.
        string description = 5;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         User specified descriptive string for this RestorePlan.
        string description = 5;
        Returns:
        The bytes for description.

      • getBackupPlan

        String getBackupPlan()
         Required. Immutable. A reference to the
 [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may
 be used as the source for Restores created via this RestorePlan. Format:
 `projects/*/locations/*/backupPlans/*`.
        string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The backupPlan.

      • getBackupPlanBytes

        com.google.protobuf.ByteString getBackupPlanBytes()
         Required. Immutable. A reference to the
 [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may
 be used as the source for Restores created via this RestorePlan. Format:
 `projects/*/locations/*/backupPlans/*`.
        string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for backupPlan.

      • getCluster

        String getCluster()
         Required. Immutable. The target cluster into which Restores created via
 this RestorePlan will restore data. NOTE: the cluster's region must be the
 same as the RestorePlan. Valid formats:

   - `projects/*/locations/*/clusters/*`
   - `projects/*/zones/*/clusters/*`
        string cluster = 7 [(.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 target cluster into which Restores created via
 this RestorePlan will restore data. NOTE: the cluster's region must be the
 same as the RestorePlan. Valid formats:

   - `projects/*/locations/*/clusters/*`
   - `projects/*/zones/*/clusters/*`
        string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for cluster.

      • hasRestoreConfig

        boolean hasRestoreConfig()
         Required. Configuration of Restores created via this RestorePlan.
        .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the restoreConfig field is set.

      • getRestoreConfig

        RestoreConfig getRestoreConfig()
         Required. Configuration of Restores created via this RestorePlan.
        .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The restoreConfig.

      • getRestoreConfigOrBuilder

        RestoreConfigOrBuilder getRestoreConfigOrBuilder()
         Required. Configuration of Restores created via this RestorePlan.
        .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • getEtag

        String getEtag()
         Output only. `etag` is used for optimistic concurrency control as a way to
 help prevent simultaneous updates of a restore from overwriting each other.
 It is strongly suggested that systems make use of the `etag` in the
 read-modify-write cycle to perform restore updates in order to avoid
 race conditions: An `etag` is returned in the response to `GetRestorePlan`,
 and systems are expected to put that etag in the request to
 `UpdateRestorePlan` or `DeleteRestorePlan` 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 restore from overwriting each other.
 It is strongly suggested that systems make use of the `etag` in the
 read-modify-write cycle to perform restore updates in order to avoid
 race conditions: An `etag` is returned in the response to `GetRestorePlan`,
 and systems are expected to put that etag in the request to
 `UpdateRestorePlan` or `DeleteRestorePlan` 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.

      • getStateValue

        int getStateValue()
         Output only. State of the RestorePlan. This State field reflects the
 various stages a RestorePlan can be in
 during the Create operation.
        .google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        RestorePlan.State getState()
         Output only. State of the RestorePlan. This State field reflects the
 various stages a RestorePlan can be in
 during the Create operation.
        .google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getStateReason

        String getStateReason()
         Output only. Human-readable description of why RestorePlan is in the
 current `state`
        string state_reason = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The stateReason.

      • getStateReasonBytes

        com.google.protobuf.ByteString getStateReasonBytes()
         Output only. Human-readable description of why RestorePlan is in the
 current `state`
        string state_reason = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for stateReason.