Skip to main content

restore_plan_bindings

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

Overview

Namerestore_plan_bindings
TypeResource
Idgoogle.gkebackup.restore_plan_bindings

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. The fully qualified name of the RestorePlanBinding. projects/*/locations/*/restoreChannels/*/restorePlanBindings/*
backupPlanstringOutput only. The fully qualified name of the BackupPlan bound to the specified RestorePlan. projects/*/locations/*/backukpPlans/{backup_plan}
createTimestring (google-datetime)Output only. The timestamp when this binding was created.
etagstringOutput only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestorePlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestorePlanBinding updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlanBinding, and systems are expected to put that etag in the request to UpdateRestorePlanBinding or DeleteRestorePlanBinding to ensure that their change will be applied to the same version of the resource.
restorePlanstringOutput only. The fully qualified name of the RestorePlan bound to this RestoreChannel. projects/*/locations/*/restorePlans/{restore_plan}
uidstringOutput only. Server generated global unique identifier of UUID4
updateTimestring (google-datetime)Output only. The timestamp when this binding was created.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, restoreChannelsId, restorePlanBindingsIdRetrieve the details of a single RestorePlanBinding.
listselectprojectsId, locationsId, restoreChannelsIdpageSize, pageToken, filter, orderByLists RestorePlanBindings 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.

NameDatatypeDescription
locationsIdstring
projectsIdstring
restoreChannelsIdstring
restorePlanBindingsIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Retrieve the details of a single RestorePlanBinding.

SELECT
name,
backupPlan,
createTime,
etag,
restorePlan,
uid,
updateTime
FROM google.gkebackup.restore_plan_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND restoreChannelsId = '{{ restoreChannelsId }}' -- required
AND restorePlanBindingsId = '{{ restorePlanBindingsId }}' -- required;