REST Resource: projects.locations.restorePlans.restores

Stay organized with collections Save and categorize content based on your preferences.

Resource: Restore

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

JSON representation
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "backup": string,
  "cluster": string,
  "restoreConfig": {
    object (RestoreConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateReason": string,
  "completeTime": string,
  "resourcesRestoredCount": integer,
  "resourcesExcludedCount": integer,
  "resourcesFailedCount": integer,
  "volumesRestoredCount": integer,
  "etag": string
}
Fields
name

string

Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

uid

string

Output only. Server generated global unique identifier of UUID format.

createTime

string (Timestamp format)

Output only. The timestamp when this Restore resource was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The timestamp when this Restore resource was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

description

string

User specified descriptive string for this Restore.

backup

string

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 backupPlan. Format: projects/*/locations/*/backupPlans/*/backups/*.

cluster

string

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.

restoreConfig

object (RestoreConfig)

Output only. Configuration of the Restore. Inherited from parent RestorePlan's restoreConfig.

labels

map (key: string, value: string)

A set of custom labels supplied by user.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (State)

Output only. The current state of the Restore.

stateReason

string

Output only. Human-readable description of why the Restore is in its current state.

completeTime

string (Timestamp format)

Output only. Timestamp of when the restore operation completed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

resourcesRestoredCount

integer

Output only. Number of resources restored during the restore execution.

resourcesExcludedCount

integer

Output only. Number of resources excluded during the restore execution.

resourcesFailedCount

integer

Output only. Number of resources that failed to be restored during the restore execution.

volumesRestoredCount

integer

Output only. Number of volumes restored during the restore execution.

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 restores.get, and systems are expected to put that etag in the request to restores.patch or restores.delete to ensure that their change will be applied to the same version of the resource.

State

Possible values for state of the Restore.

Enums
STATE_UNSPECIFIED The Restore resource is in the process of being created.
CREATING The Restore resource has been created and the associated RestoreJob Kubernetes resource has been injected into target cluster.
IN_PROGRESS The gkebackup agent in the cluster has begun executing the restore operation.
SUCCEEDED The restore operation has completed successfully. Restored workloads may not yet be operational.
FAILED The restore operation has failed.
DELETING This Restore resource is in the process of being deleted.

Methods

create

Creates a new Restore for the given RestorePlan.

delete

Deletes an existing Restore.

get

Retrieves the details of a single Restore.

getIamPolicy

Gets the access control policy for a resource.

list

Lists the Restores for a given RestorePlan.

patch

Update a Restore.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.