backup_channels

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

Overview

Name	backup_channels
Type	Resource
Id	google.gkebackup.backup_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 BackupChannel. projects/*/locations/*/backupChannels/*
createTime	string (google-datetime)	Output only. The timestamp when this BackupChannel resource was created.
description	string	Optional. User specified descriptive string for this BackupChannel.
destinationProject	string	Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.
destinationProjectId	string	Output only. The project_id where Backups are allowed to be stored. 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 BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel 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 BackupChannel resource was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*
createTime	string (google-datetime)	Output only. The timestamp when this BackupChannel resource was created.
description	string	Optional. User specified descriptive string for this BackupChannel.
destinationProject	string	Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.
destinationProjectId	string	Output only. The project_id where Backups are allowed to be stored. 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 BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel 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 BackupChannel resource was last updated.

Methods

The following methods are available for this resource:

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

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
backupChannelsId	string
locationsId	string
projectsId	string
backupChannelId	string
etag	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Retrieve the details of a single BackupChannel.

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

list

Lists BackupChannels in a given location.

SELECT
name,
createTime,
description,
destinationProject,
destinationProjectId,
etag,
labels,
uid,
updateTime
FROM google.gkebackup.backup_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 BackupChannel in a given location.

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

Manifest

# Description fields are for documentation purposes
- name: backup_channels
  props:
    - name: projectsId
      value: string
      description: Required parameter for the backup_channels resource.
    - name: locationsId
      value: string
      description: Required parameter for the backup_channels resource.
    - name: name
      value: string
      description: >
        Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*`
        
    - name: destinationProject
      value: string
      description: >
        Required. Immutable. The project where Backups are allowed to be stored. 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 BackupChannel.
        
    - name: backupChannelId
      value: string

UPDATE examples

patch

Update a BackupChannel.

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

DELETE examples

delete

Deletes an existing BackupChannel.

DELETE FROM google.gkebackup.backup_channels
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backupChannelsId = '{{ backupChannelsId }}' --required
AND etag = '{{ etag }}'
AND force = '{{ force }}';