Interface RestoreOrBuilder

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

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

    • getName

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

      boolean hasUpdateTime()
       Output only. The timestamp when this Restore 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 Restore 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 Restore 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 Restore.
       
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

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

      String getBackup()
       Required. Immutable. A reference to the
       [Backup][google.cloud.gkebackup.v1.Backup] used as the source from which
       this Restore will restore. Note that this Backup must be a sub-resource of
       the RestorePlan's
       [backup_plan][google.cloud.gkebackup.v1.RestorePlan.backup_plan]. Format:
       `projects/*/locations/*/backupPlans/*/backups/*`.
       
      string backup = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The backup.
    • getBackupBytes

      com.google.protobuf.ByteString getBackupBytes()
       Required. Immutable. A reference to the
       [Backup][google.cloud.gkebackup.v1.Backup] used as the source from which
       this Restore will restore. Note that this Backup must be a sub-resource of
       the RestorePlan's
       [backup_plan][google.cloud.gkebackup.v1.RestorePlan.backup_plan]. Format:
       `projects/*/locations/*/backupPlans/*/backups/*`.
       
      string backup = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for backup.
    • getCluster

      String getCluster()
       Output only. The target cluster into which this Restore will restore data.
       Valid formats:
      
       - `projects/*/locations/*/clusters/*`
       - `projects/*/zones/*/clusters/*`
      
       Inherited from parent RestorePlan's
       [cluster][google.cloud.gkebackup.v1.RestorePlan.cluster] value.
       
      string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The cluster.
    • getClusterBytes

      com.google.protobuf.ByteString getClusterBytes()
       Output only. The target cluster into which this Restore will restore data.
       Valid formats:
      
       - `projects/*/locations/*/clusters/*`
       - `projects/*/zones/*/clusters/*`
      
       Inherited from parent RestorePlan's
       [cluster][google.cloud.gkebackup.v1.RestorePlan.cluster] value.
       
      string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for cluster.
    • hasRestoreConfig

      boolean hasRestoreConfig()
       Output only. Configuration of the Restore.  Inherited from parent
       RestorePlan's
       [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
       
      .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the restoreConfig field is set.
    • getRestoreConfig

      RestoreConfig getRestoreConfig()
       Output only. Configuration of the Restore.  Inherited from parent
       RestorePlan's
       [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
       
      .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The restoreConfig.
    • getRestoreConfigOrBuilder

      RestoreConfigOrBuilder getRestoreConfigOrBuilder()
       Output only. Configuration of the Restore.  Inherited from parent
       RestorePlan's
       [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
       
      .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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;
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • 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;
    • getStateValue

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

      Restore.State getState()
       Output only. The current state of the Restore.
       
      .google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • getStateReason

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

      com.google.protobuf.ByteString getStateReasonBytes()
       Output only. Human-readable description of why the Restore is in its
       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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for stateReason.
    • hasCompleteTime

      boolean hasCompleteTime()
       Output only. Timestamp of when the restore operation completed.
       
      .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the completeTime field is set.
    • getCompleteTime

      com.google.protobuf.Timestamp getCompleteTime()
       Output only. Timestamp of when the restore operation completed.
       
      .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The completeTime.
    • getCompleteTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder()
       Output only. Timestamp of when the restore operation completed.
       
      .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getResourcesRestoredCount

      int getResourcesRestoredCount()
       Output only. Number of resources restored during the restore execution.
       
      int32 resources_restored_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The resourcesRestoredCount.
    • getResourcesExcludedCount

      int getResourcesExcludedCount()
       Output only. Number of resources excluded during the restore execution.
       
      int32 resources_excluded_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The resourcesExcludedCount.
    • getResourcesFailedCount

      int getResourcesFailedCount()
       Output only. Number of resources that failed to be restored during the
       restore execution.
       
      int32 resources_failed_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The resourcesFailedCount.
    • getVolumesRestoredCount

      int getVolumesRestoredCount()
       Output only. Number of volumes restored during the restore execution.
       
      int32 volumes_restored_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The volumesRestoredCount.
    • 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 `GetRestore`,
       and systems are expected to put that etag in the request to
       `UpdateRestore` or `DeleteRestore` to ensure that their change will be
       applied to the same version of the resource.
       
      string etag = 17 [(.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 `GetRestore`,
       and systems are expected to put that etag in the request to
       `UpdateRestore` or `DeleteRestore` to ensure that their change will be
       applied to the same version of the resource.
       
      string etag = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for etag.
    • hasFilter

      boolean hasFilter()
       Optional. Immutable. Filters resources for `Restore`. If not specified, the
       scope of the restore will remain the same as defined in the `RestorePlan`.
       If this is specified and no resources are matched by the
       `inclusion_filters` or everything is excluded by the `exclusion_filters`,
       nothing will be restored. This filter can only be specified if the value of
       [namespaced_resource_restore_mode][google.cloud.gkebackup.v1.RestoreConfig.namespaced_resource_restore_mode]
       is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or
       `MERGE_REPLACE_ON_CONFLICT`.
       
      .google.cloud.gkebackup.v1.Restore.Filter filter = 18 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the filter field is set.
    • getFilter

      Restore.Filter getFilter()
       Optional. Immutable. Filters resources for `Restore`. If not specified, the
       scope of the restore will remain the same as defined in the `RestorePlan`.
       If this is specified and no resources are matched by the
       `inclusion_filters` or everything is excluded by the `exclusion_filters`,
       nothing will be restored. This filter can only be specified if the value of
       [namespaced_resource_restore_mode][google.cloud.gkebackup.v1.RestoreConfig.namespaced_resource_restore_mode]
       is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or
       `MERGE_REPLACE_ON_CONFLICT`.
       
      .google.cloud.gkebackup.v1.Restore.Filter filter = 18 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.
    • getFilterOrBuilder

      Restore.FilterOrBuilder getFilterOrBuilder()
       Optional. Immutable. Filters resources for `Restore`. If not specified, the
       scope of the restore will remain the same as defined in the `RestorePlan`.
       If this is specified and no resources are matched by the
       `inclusion_filters` or everything is excluded by the `exclusion_filters`,
       nothing will be restored. This filter can only be specified if the value of
       [namespaced_resource_restore_mode][google.cloud.gkebackup.v1.RestoreConfig.namespaced_resource_restore_mode]
       is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or
       `MERGE_REPLACE_ON_CONFLICT`.
       
      .google.cloud.gkebackup.v1.Restore.Filter filter = 18 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
    • getVolumeDataRestorePolicyOverridesList

      List<VolumeDataRestorePolicyOverride> getVolumeDataRestorePolicyOverridesList()
       Optional. Immutable. Overrides the volume data restore policies selected in
       the Restore Config for override-scoped resources.
       
      repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
    • getVolumeDataRestorePolicyOverrides

      VolumeDataRestorePolicyOverride getVolumeDataRestorePolicyOverrides(int index)
       Optional. Immutable. Overrides the volume data restore policies selected in
       the Restore Config for override-scoped resources.
       
      repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
    • getVolumeDataRestorePolicyOverridesCount

      int getVolumeDataRestorePolicyOverridesCount()
       Optional. Immutable. Overrides the volume data restore policies selected in
       the Restore Config for override-scoped resources.
       
      repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
    • getVolumeDataRestorePolicyOverridesOrBuilderList

      List<? extends VolumeDataRestorePolicyOverrideOrBuilder> getVolumeDataRestorePolicyOverridesOrBuilderList()
       Optional. Immutable. Overrides the volume data restore policies selected in
       the Restore Config for override-scoped resources.
       
      repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
    • getVolumeDataRestorePolicyOverridesOrBuilder

      VolumeDataRestorePolicyOverrideOrBuilder getVolumeDataRestorePolicyOverridesOrBuilder(int index)
       Optional. Immutable. Overrides the volume data restore policies selected in
       the Restore Config for override-scoped resources.
       
      repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];