backup_plan_bindings

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

Overview

Name	backup_plan_bindings
Type	Resource
Id	google.gkebackup.backup_plan_bindings

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The fully qualified name of the BackupPlanBinding. projects/*/locations/*/backupChannels/*/backupPlanBindings/*
backupPlan	string	Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. projects/*/locations/*/backupPlans/{backup_plan}
backupPlanDetails	object	Output only. Contains details about the backup plan/backup. (id: BackupPlanDetails)
cluster	string	Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
createTime	string (google-datetime)	Output only. The timestamp when this binding was created.
etag	string	Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlanBinding, and systems are expected to put that etag in the request to UpdateBackupPlanBinding or DeleteBackupPlanBinding to ensure that their change will be applied to the same version of the resource.
uid	string	Output only. Server generated global unique identifier of UUID4
updateTime	string (google-datetime)	Output only. The timestamp when this binding was created.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The fully qualified name of the BackupPlanBinding. projects/*/locations/*/backupChannels/*/backupPlanBindings/*
backupPlan	string	Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. projects/*/locations/*/backupPlans/{backup_plan}
backupPlanDetails	object	Output only. Contains details about the backup plan/backup. (id: BackupPlanDetails)
cluster	string	Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
createTime	string (google-datetime)	Output only. The timestamp when this binding was created.
etag	string	Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlanBinding, and systems are expected to put that etag in the request to UpdateBackupPlanBinding or DeleteBackupPlanBinding to ensure that their change will be applied to the same version of the resource.
uid	string	Output only. Server generated global unique identifier of UUID4
updateTime	string (google-datetime)	Output only. The timestamp when this binding was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backupChannelsId, backupPlanBindingsId		Retrieve the details of a single BackupPlanBinding.
list	select	projectsId, locationsId, backupChannelsId	pageSize, pageToken, filter, orderBy	Lists BackupPlanBindings in a given location.

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
backupPlanBindingsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieve the details of a single BackupPlanBinding.

SELECT
name,
backupPlan,
backupPlanDetails,
cluster,
createTime,
etag,
uid,
updateTime
FROM google.gkebackup.backup_plan_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupChannelsId = '{{ backupChannelsId }}' -- required
AND backupPlanBindingsId = '{{ backupPlanBindingsId }}' -- required;

list

Lists BackupPlanBindings in a given location.

SELECT
name,
backupPlan,
backupPlanDetails,
cluster,
createTime,
etag,
uid,
updateTime
FROM google.gkebackup.backup_plan_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupChannelsId = '{{ backupChannelsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';