restore_channels

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

Overview

Name	restore_channels
Type	Resource
Id	google.gkebackup.restore_channels

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The fully qualified name of the RestoreChannel. projects/*/locations/*/restoreChannels/*
createTime	string (google-datetime)	Output only. The timestamp when this RestoreChannel was created.
description	string	Optional. User specified descriptive string for this RestoreChannel.
destinationProject	string	Required. Immutable. The project into which the backups will be restored. The format is projects/{projectId} or projects/{projectNumber}.
destinationProjectId	string	Output only. The project_id where backups will be restored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.
etag	string	Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An etag is returned in the response to GetRestoreChannel, and systems are expected to put that etag in the request to UpdateRestoreChannel or DeleteRestoreChannel 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.
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string (google-datetime)	Output only. The timestamp when this RestoreChannel was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The fully qualified name of the RestoreChannel. projects/*/locations/*/restoreChannels/*
createTime	string (google-datetime)	Output only. The timestamp when this RestoreChannel was created.
description	string	Optional. User specified descriptive string for this RestoreChannel.
destinationProject	string	Required. Immutable. The project into which the backups will be restored. The format is projects/{projectId} or projects/{projectNumber}.
destinationProjectId	string	Output only. The project_id where backups will be restored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.
etag	string	Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An etag is returned in the response to GetRestoreChannel, and systems are expected to put that etag in the request to UpdateRestoreChannel or DeleteRestoreChannel 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.
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string (google-datetime)	Output only. The timestamp when this RestoreChannel was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, restoreChannelsId		Retrieve the details of a single RestoreChannel.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists RestoreChannels in a given location.
create	insert	projectsId, locationsId	restoreChannelId	Creates a new RestoreChannel in a given location.
patch	update	projectsId, locationsId, restoreChannelsId	updateMask	Update a RestoreChannel.
delete	delete	projectsId, locationsId, restoreChannelsId	etag	Deletes an existing RestoreChannel.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
restoreChannelsId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
restoreChannelId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Retrieve the details of a single RestoreChannel.

SELECT
name,
createTime,
description,
destinationProject,
destinationProjectId,
etag,
labels,
uid,
updateTime
FROM google.gkebackup.restore_channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND restoreChannelsId = '{{ restoreChannelsId }}' -- required;

list

Lists RestoreChannels in a given location.

SELECT
name,
createTime,
description,
destinationProject,
destinationProjectId,
etag,
labels,
uid,
updateTime
FROM google.gkebackup.restore_channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new RestoreChannel in a given location.

INSERT INTO google.gkebackup.restore_channels (
data__name,
data__destinationProject,
data__labels,
data__description,
projectsId,
locationsId,
restoreChannelId
)
SELECT 
'{{ name }}',
'{{ destinationProject }}',
'{{ labels }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ restoreChannelId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: restore_channels
  props:
    - name: projectsId
      value: string
      description: Required parameter for the restore_channels resource.
    - name: locationsId
      value: string
      description: Required parameter for the restore_channels resource.
    - name: name
      value: string
      description: >
        Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*`
        
    - name: destinationProject
      value: string
      description: >
        Required. Immutable. The project into which the backups will be restored. The format is `projects/{projectId}` or `projects/{projectNumber}`.
        
    - name: labels
      value: object
      description: >
        Optional. A set of custom labels supplied by user.
        
    - name: description
      value: string
      description: >
        Optional. User specified descriptive string for this RestoreChannel.
        
    - name: restoreChannelId
      value: string

UPDATE examples

patch

Update a RestoreChannel.

UPDATE google.gkebackup.restore_channels
SET 
data__name = '{{ name }}',
data__destinationProject = '{{ destinationProject }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND restoreChannelsId = '{{ restoreChannelsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes an existing RestoreChannel.

DELETE FROM google.gkebackup.restore_channels
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND restoreChannelsId = '{{ restoreChannelsId }}' --required
AND etag = '{{ etag }}';