Skip to main content

restores

Overview

Namerestores
TypeResource
Idgoogle.gkebackup.restores

Fields

NameDatatypeDescription
namestringOutput only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
descriptionstringUser specified descriptive string for this Restore.
backupstringRequired. 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/*.
clusterstringOutput 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.
completeTimestringOutput only. Timestamp of when the restore operation completed.
createTimestringOutput only. The timestamp when this Restore resource was created.
etagstringOutput 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.
labelsobjectA set of custom labels supplied by user.
resourcesExcludedCountintegerOutput only. Number of resources excluded during the restore execution.
resourcesFailedCountintegerOutput only. Number of resources that failed to be restored during the restore execution.
resourcesRestoredCountintegerOutput only. Number of resources restored during the restore execution.
restoreConfigobjectConfiguration of a restore. Next id: 12
statestringOutput only. The current state of the Restore.
stateReasonstringOutput only. Human-readable description of why the Restore is in its current state.
uidstringOutput only. Server generated global unique identifier of UUID format.
updateTimestringOutput only. The timestamp when this Restore resource was last updated.
volumesRestoredCountintegerOutput only. Number of volumes restored during the restore execution.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, restorePlansId, restoresIdRetrieves the details of a single Restore.
listSELECTlocationsId, projectsId, restorePlansIdLists the Restores for a given RestorePlan.
createINSERTlocationsId, projectsId, restorePlansIdCreates a new Restore for the given RestorePlan.
deleteDELETElocationsId, projectsId, restorePlansId, restoresIdDeletes an existing Restore.
_listEXEClocationsId, projectsId, restorePlansIdLists the Restores for a given RestorePlan.
patchEXEClocationsId, projectsId, restorePlansId, restoresIdUpdate a Restore.