Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupPlanBinding.
A BackupPlanBinding binds a BackupPlan with a BackupChannel.
This resource is created automatically when a BackupPlan is created using a
BackupChannel. This also serves as a holder for cross-project fields
that need to be displayed in the current project.
Generated from protobuf messagegoogle.cloud.gkebackup.v1.BackupPlanBinding
Namespace
Google \ Cloud \ GkeBackup \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The fully qualified name of the BackupPlanBinding.projects/*/locations/*/backupChannels/*/backupPlanBindings/*
↳ uid
string
Output only. Server generated global unique identifier ofUUID4
Output only. The timestamp when this binding was created.
↳ backup_plan
string
Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel.projects/*/locations/*/backupPlans/{backup_plan}
↳ 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/*
Output only. Contains details about the backup plan/backup.
↳ etag
string
Output only.etagis 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: Anetagis returned in the response toGetBackupPlanBinding, and systems are expected to put that etag in the request toUpdateBackupPlanBindingorDeleteBackupPlanBindingto ensure that their change will be applied to the same version of the resource.
getName
Identifier. The fully qualified name of the BackupPlanBinding.
Output only.etagis 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: Anetagis returned in the response toGetBackupPlanBinding, and systems are expected to put that etag in
the request toUpdateBackupPlanBindingorDeleteBackupPlanBindingto ensure that their change will be applied
to the same version of the resource.
Returns
Type
Description
string
setEtag
Output only.etagis 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: Anetagis returned in the response toGetBackupPlanBinding, and systems are expected to put that etag in
the request toUpdateBackupPlanBindingorDeleteBackupPlanBindingto ensure that their change will be applied
to the same version of the resource.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Gke Backup V1 Client - Class BackupPlanBinding (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlanBinding)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.BackupPlanBinding)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.BackupPlanBinding)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.BackupPlanBinding)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.BackupPlanBinding)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.BackupPlanBinding)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.BackupPlanBinding)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.BackupPlanBinding)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.BackupPlanBinding)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.BackupPlanBinding)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.BackupPlanBinding) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupPlanBinding.\n\nA BackupPlanBinding binds a BackupPlan with a BackupChannel.\n\nThis resource is created automatically when a BackupPlan is created using a\nBackupChannel. This also serves as a holder for cross-project fields\nthat need to be displayed in the current project.\n\nGenerated from protobuf message `google.cloud.gkebackup.v1.BackupPlanBinding`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nIdentifier. The fully qualified name of the BackupPlanBinding.\n\n`projects/*/locations/*/backupChannels/*/backupPlanBindings/*`\n\n### setName\n\nIdentifier. The fully qualified name of the BackupPlanBinding.\n\n`projects/*/locations/*/backupChannels/*/backupPlanBindings/*`\n\n### getUid\n\nOutput only. Server generated global unique identifier of\n[UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)\n\n### setUid\n\nOutput only. Server generated global unique identifier of\n[UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)\n\n### getCreateTime\n\nOutput only. The timestamp when this binding was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The timestamp when this binding was created.\n\n### getUpdateTime\n\nOutput only. The timestamp when this binding was created.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The timestamp when this binding was created.\n\n### getBackupPlan\n\nOutput only. Immutable. The fully qualified name of the BackupPlan bound\nwith the parent BackupChannel.\n\n`projects/*/locations/*/backupPlans/{backup_plan}`\n\n### setBackupPlan\n\nOutput only. Immutable. The fully qualified name of the BackupPlan bound\nwith the parent BackupChannel.\n\n`projects/*/locations/*/backupPlans/{backup_plan}`\n\n### getCluster\n\nOutput only. Immutable. The fully qualified name of the cluster that is\nbeing backed up Valid formats:\n\n- `projects/*/locations/*/clusters/*`\n- `projects/*/zones/*/clusters/*`\n\n### setCluster\n\nOutput only. Immutable. The fully qualified name of the cluster that is\nbeing backed up Valid formats:\n\n- `projects/*/locations/*/clusters/*`\n- `projects/*/zones/*/clusters/*`\n\n### getBackupPlanDetails\n\nOutput only. Contains details about the backup plan/backup.\n\n### hasBackupPlanDetails\n\n### clearBackupPlanDetails\n\n### setBackupPlanDetails\n\nOutput only. Contains details about the backup plan/backup.\n\n### getEtag\n\nOutput only. `etag` is used for optimistic concurrency control as a way to\nhelp prevent simultaneous updates of a BackupPlanBinding from overwriting\neach other. It is strongly suggested that systems make use of the 'etag' in\nthe read-modify-write cycle to perform BackupPlanBinding updates in\norder to avoid race conditions: An `etag` is returned in the response to\n`GetBackupPlanBinding`, and systems are expected to put that etag in\nthe request to `UpdateBackupPlanBinding` or\n`DeleteBackupPlanBinding` to ensure that their change will be applied\nto the same version of the resource.\n\n### setEtag\n\nOutput only. `etag` is used for optimistic concurrency control as a way to\nhelp prevent simultaneous updates of a BackupPlanBinding from overwriting\neach other. It is strongly suggested that systems make use of the 'etag' in\nthe read-modify-write cycle to perform BackupPlanBinding updates in\norder to avoid race conditions: An `etag` is returned in the response to\n`GetBackupPlanBinding`, and systems are expected to put that etag in\nthe request to `UpdateBackupPlanBinding` or\n`DeleteBackupPlanBinding` to ensure that their change will be applied\nto the same version of the resource."]]
