restore_plans

Overview

Name	restore_plans
Type	Resource
Id	google.gkebackup.restore_plans

Fields

Name	Datatype	Description
name	string	Output only. The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.
description	string	Optional. User specified descriptive string for this RestorePlan.
backupPlan	string	Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.
cluster	string	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/*
createTime	string	Output only. The timestamp when this RestorePlan resource was created.
etag	string	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.
labels	object	Optional. A set of custom labels supplied by user.
restoreConfig	object	Configuration of a restore. Next id: 12
state	string	Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.
stateReason	string	Output only. Human-readable description of why RestorePlan is in the current state
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string	Output only. The timestamp when this RestorePlan resource was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, restorePlansId	Retrieve the details of a single RestorePlan.
list	SELECT	locationsId, projectsId	Lists RestorePlans in a given location.
create	INSERT	locationsId, projectsId	Creates a new RestorePlan in a given location.
delete	DELETE	locationsId, projectsId, restorePlansId	Deletes an existing RestorePlan.
_list	EXEC	locationsId, projectsId	Lists RestorePlans in a given location.
patch	EXEC	locationsId, projectsId, restorePlansId	Update a RestorePlan.