REST Resource: projects.locations.backupChannels

Resource: BackupChannel

A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destinationProject.

JSON representation
{
  "name": string,
  "destinationProject": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "etag": string,
  "destinationProjectId": string
}
Fields
name

string

Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

destinationProject

string

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

uid

string

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

createTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. 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" }.

description

string

Optional. User specified descriptive string for this BackupChannel.

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

destinationProjectId

string

Output only. The projectId where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the projectId of the destination project.

Methods

create

Creates a new BackupChannel in a given location.

delete

Deletes an existing BackupChannel.

get

Retrieve the details of a single BackupChannel.

list

Lists BackupChannels in a given location.

patch

Update a BackupChannel.