restore_plans

Creates, updates, deletes, gets or lists a restore_plans resource.

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.
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.
patch	UPDATE	locationsId, projectsId, restorePlansId	Update a RestorePlan.

SELECT examples

Lists RestorePlans in a given location.

SELECT
name,
description,
backupPlan,
cluster,
createTime,
etag,
labels,
restoreConfig,
state,
stateReason,
uid,
updateTime
FROM google.gkebackup.restore_plans
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new restore_plans resource.

All Properties

/*+ create */
INSERT INTO google.gkebackup.restore_plans (
locationsId,
projectsId,
description,
backupPlan,
cluster,
restoreConfig,
labels
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ backupPlan }}',
'{{ cluster }}',
'{{ restoreConfig }}',
'{{ labels }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: description
      value: string
    - name: backupPlan
      value: string
    - name: cluster
      value: string
    - name: restoreConfig
      value:
        - name: volumeDataRestorePolicy
          value: string
        - name: clusterResourceConflictPolicy
          value: string
        - name: namespacedResourceRestoreMode
          value: string
        - name: clusterResourceRestoreScope
          value:
            - name: selectedGroupKinds
              value:
                - - name: resourceGroup
                    value: string
                  - name: resourceKind
                    value: string
            - name: excludedGroupKinds
              value:
                - - name: resourceGroup
                    value: string
                  - name: resourceKind
                    value: string
            - name: allGroupKinds
              value: boolean
            - name: noGroupKinds
              value: boolean
        - name: allNamespaces
          value: boolean
        - name: selectedNamespaces
          value:
            - name: namespaces
              value:
                - string
        - name: selectedApplications
          value:
            - name: namespacedNames
              value:
                - - name: namespace
                    value: string
                  - name: name
                    value: string
        - name: noNamespaces
          value: boolean
        - name: substitutionRules
          value:
            - - name: targetNamespaces
                value:
                  - string
              - name: targetGroupKinds
                value:
                  - - name: resourceGroup
                      value: string
                    - name: resourceKind
                      value: string
              - name: targetJsonPath
                value: string
              - name: originalValuePattern
                value: string
              - name: newValue
                value: string
        - name: transformationRules
          value:
            - - name: fieldActions
                value:
                  - - name: op
                      value: string
                    - name: fromPath
                      value: string
                    - name: path
                      value: string
                    - name: value
                      value: string
              - name: resourceFilter
                value:
                  - name: namespaces
                    value:
                      - string
                  - name: groupKinds
                    value:
                      - - name: resourceGroup
                          value: string
                        - name: resourceKind
                          value: string
                  - name: jsonPath
                    value: string
              - name: description
                value: string
        - name: volumeDataRestorePolicyBindings
          value:
            - - name: policy
                value: string
              - name: volumeType
                value: string
        - name: restoreOrder
          value:
            - name: groupKindDependencies
              value:
                - - name: satisfying
                    value:
                      - name: resourceGroup
                        value: string
                      - name: resourceKind
                        value: string
    - name: labels
      value: object
    - name: etag
      value: string
    - name: state
      value: string
    - name: stateReason
      value: string

UPDATE example

Updates a restore_plans resource.

/*+ update */
UPDATE google.gkebackup.restore_plans
SET 
description = '{{ description }}',
backupPlan = '{{ backupPlan }}',
cluster = '{{ cluster }}',
restoreConfig = '{{ restoreConfig }}',
labels = '{{ labels }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND restorePlansId = '{{ restorePlansId }}';

DELETE example

Deletes the specified restore_plans resource.

/*+ delete */
DELETE FROM google.gkebackup.restore_plans
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND restorePlansId = '{{ restorePlansId }}';