View Source GoogleApi.GKEBackup.V1.Model.Restore (google_api_gke_backup v0.6.0)

Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.

Attributes

  • backup (type: String.t, default: nil) - Required. Immutable. A reference to the 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. Format: projects/*/locations/*/backupPlans/*/backups/*.
  • cluster (type: String.t, default: nil) - 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 value.
  • completeTime (type: DateTime.t, default: nil) - Output only. Timestamp of when the restore operation completed.
  • createTime (type: DateTime.t, default: nil) - Output only. The timestamp when this Restore resource was created.
  • description (type: String.t, default: nil) - User specified descriptive string for this Restore.
  • etag (type: String.t, default: nil) - 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.
  • filter (type: GoogleApi.GKEBackup.V1.Model.Filter.t, default: nil) - 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 everyting is excluded by the exclusion_filters, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to MERGE_SKIP_ON_CONFLICT, MERGE_REPLACE_VOLUME_ON_CONFLICT or MERGE_REPLACE_ON_CONFLICT.
  • labels (type: map(), default: nil) - A set of custom labels supplied by user.
  • name (type: String.t, default: nil) - Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
  • resourcesExcludedCount (type: integer(), default: nil) - Output only. Number of resources excluded during the restore execution.
  • resourcesFailedCount (type: integer(), default: nil) - Output only. Number of resources that failed to be restored during the restore execution.
  • resourcesRestoredCount (type: integer(), default: nil) - Output only. Number of resources restored during the restore execution.
  • restoreConfig (type: GoogleApi.GKEBackup.V1.Model.RestoreConfig.t, default: nil) - Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
  • state (type: String.t, default: nil) - Output only. The current state of the Restore.
  • stateReason (type: String.t, default: nil) - Output only. Human-readable description of why the Restore is in its current state.
  • uid (type: String.t, default: nil) - Output only. Server generated global unique identifier of UUID format.
  • updateTime (type: DateTime.t, default: nil) - Output only. The timestamp when this Restore resource was last updated.
  • volumeDataRestorePolicyOverrides (type: list(GoogleApi.GKEBackup.V1.Model.VolumeDataRestorePolicyOverride.t), default: nil) - Optional. Immutable. Overrides the volume data restore policies selected in the Restore Config for override-scoped resources.
  • volumesRestoredCount (type: integer(), default: nil) - Output only. Number of volumes restored during the restore execution.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.GKEBackup.V1.Model.Restore{
  backup: String.t() | nil,
  cluster: String.t() | nil,
  completeTime: DateTime.t() | nil,
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
  filter: GoogleApi.GKEBackup.V1.Model.Filter.t() | nil,
  labels: map() | nil,
  name: String.t() | nil,
  resourcesExcludedCount: integer() | nil,
  resourcesFailedCount: integer() | nil,
  resourcesRestoredCount: integer() | nil,
  restoreConfig: GoogleApi.GKEBackup.V1.Model.RestoreConfig.t() | nil,
  state: String.t() | nil,
  stateReason: String.t() | nil,
  uid: String.t() | nil,
  updateTime: DateTime.t() | nil,
  volumeDataRestorePolicyOverrides:
    [GoogleApi.GKEBackup.V1.Model.VolumeDataRestorePolicyOverride.t()] | nil,
  volumesRestoredCount: integer() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.