Backup for GKE V1 API - Module Google::Cloud::GkeBackup::V1::BackupForGKE::Paths (v1.3.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Backup for GKE V1 API module Google::Cloud::GkeBackup::V1::BackupForGKE::Paths.
Path helper methods for the BackupForGKE API.
Methods
#backup_channel_path
def backup_channel_path(project:, location:, backup_channel:) -> ::String
Create a fully-qualified BackupChannel resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/backupChannels/{backup_channel}
Parameters
-
project (String)
-
location (String)
-
backup_channel (String)
#backup_path
def backup_path(project:, location:, backup_plan:, backup:) -> ::String
Create a fully-qualified Backup resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
Parameters
-
project (String)
-
location (String)
-
backup_plan (String)
-
backup (String)
#backup_plan_binding_path
def backup_plan_binding_path(project:, location:, backup_channel:, backup_plan_binding:) -> ::String
Create a fully-qualified BackupPlanBinding resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/backupChannels/{backup_channel}/backupPlanBindings/{backup_plan_binding}
Parameters
-
project (String)
-
location (String)
-
backup_channel (String)
-
backup_plan_binding (String)
#backup_plan_path
def backup_plan_path(project:, location:, backup_plan:) -> ::String
Create a fully-qualified BackupPlan resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/backupPlans/{backup_plan}
Parameters
-
project (String)
-
location (String)
-
backup_plan (String)
#cluster_path
def cluster_path(project:, location:, cluster:) -> ::String
Create a fully-qualified Cluster resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/clusters/{cluster}
Parameters
-
project (String)
-
location (String)
-
cluster (String)
#crypto_key_path
def crypto_key_path(project:, location:, key_ring:, crypto_key:) -> ::String
Create a fully-qualified CryptoKey resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
Parameters
-
project (String)
-
location (String)
-
key_ring (String)
-
crypto_key (String)
#location_path
def location_path(project:, location:) -> ::String
Create a fully-qualified Location resource string.
The resource will be in the following format:
projects/{project}/locations/{location}
Parameters
-
project (String)
-
location (String)
#restore_channel_path
def restore_channel_path(project:, location:, restore_channel:) -> ::String
Create a fully-qualified RestoreChannel resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/restoreChannels/{restore_channel}
Parameters
-
project (String)
-
location (String)
-
restore_channel (String)
#restore_path
def restore_path(project:, location:, restore_plan:, restore:) -> ::String
Create a fully-qualified Restore resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
Parameters
-
project (String)
-
location (String)
-
restore_plan (String)
-
restore (String)
#restore_plan_binding_path
def restore_plan_binding_path(project:, location:, restore_channel:, restore_plan_binding:) -> ::String
Create a fully-qualified RestorePlanBinding resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}
Parameters
-
project (String)
-
location (String)
-
restore_channel (String)
-
restore_plan_binding (String)
#restore_plan_path
def restore_plan_path(project:, location:, restore_plan:) -> ::String
Create a fully-qualified RestorePlan resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/restorePlans/{restore_plan}
Parameters
-
project (String)
-
location (String)
-
restore_plan (String)
#volume_backup_path
def volume_backup_path(project:, location:, backup_plan:, backup:, volume_backup:) -> ::String
Create a fully-qualified VolumeBackup resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}
Parameters
-
project (String)
-
location (String)
-
backup_plan (String)
-
backup (String)
-
volume_backup (String)
#volume_restore_path
def volume_restore_path(project:, location:, restore_plan:, restore:, volume_restore:) -> ::String
Create a fully-qualified VolumeRestore resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}
Parameters
-
project (String)
-
location (String)
-
restore_plan (String)
-
restore (String)
-
volume_restore (String)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["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,["# Backup for GKE V1 API - Module Google::Cloud::GkeBackup::V1::BackupForGKE::Paths (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-gke_backup-v1/latest/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [1.2.0](/ruby/docs/reference/google-cloud-gke_backup-v1/1.2.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [1.1.1](/ruby/docs/reference/google-cloud-gke_backup-v1/1.1.1/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [1.0.0](/ruby/docs/reference/google-cloud-gke_backup-v1/1.0.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.12.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.12.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.11.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.11.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.10.1](/ruby/docs/reference/google-cloud-gke_backup-v1/0.10.1/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.9.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.9.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.8.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.8.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.7.2](/ruby/docs/reference/google-cloud-gke_backup-v1/0.7.2/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.6.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.6.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.5.1](/ruby/docs/reference/google-cloud-gke_backup-v1/0.5.1/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.4.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.4.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.3.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.3.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.2.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.2.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n- [0.1.0](/ruby/docs/reference/google-cloud-gke_backup-v1/0.1.0/Google-Cloud-GkeBackup-V1-BackupForGKE-Paths) \nReference documentation and code samples for the Backup for GKE V1 API module Google::Cloud::GkeBackup::V1::BackupForGKE::Paths.\n\nPath helper methods for the BackupForGKE API. \n\nExtended By\n-----------\n\n- [Google::Cloud::GkeBackup::V1::BackupForGKE::Paths](./Google-Cloud-GkeBackup-V1-BackupForGKE-Paths)\n\nMethods\n-------\n\n### #backup_channel_path\n\n def backup_channel_path(project:, location:, backup_channel:) -\u003e ::String\n\nCreate a fully-qualified BackupChannel resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/backupChannels/{backup_channel}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **backup_channel** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #backup_path\n\n def backup_path(project:, location:, backup_plan:, backup:) -\u003e ::String\n\nCreate a fully-qualified Backup resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **backup_plan** (String)\n- **backup** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #backup_plan_binding_path\n\n def backup_plan_binding_path(project:, location:, backup_channel:, backup_plan_binding:) -\u003e ::String\n\nCreate a fully-qualified BackupPlanBinding resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/backupChannels/{backup_channel}/backupPlanBindings/{backup_plan_binding}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **backup_channel** (String)\n- **backup_plan_binding** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #backup_plan_path\n\n def backup_plan_path(project:, location:, backup_plan:) -\u003e ::String\n\nCreate a fully-qualified BackupPlan resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/backupPlans/{backup_plan}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **backup_plan** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #cluster_path\n\n def cluster_path(project:, location:, cluster:) -\u003e ::String\n\nCreate a fully-qualified Cluster resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/clusters/{cluster}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **cluster** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #crypto_key_path\n\n def crypto_key_path(project:, location:, key_ring:, crypto_key:) -\u003e ::String\n\nCreate a fully-qualified CryptoKey resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **key_ring** (String)\n- **crypto_key** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #location_path\n\n def location_path(project:, location:) -\u003e ::String\n\nCreate a fully-qualified Location resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}` \n**Parameters**\n\n- **project** (String)\n- **location** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #restore_channel_path\n\n def restore_channel_path(project:, location:, restore_channel:) -\u003e ::String\n\nCreate a fully-qualified RestoreChannel resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/restoreChannels/{restore_channel}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **restore_channel** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #restore_path\n\n def restore_path(project:, location:, restore_plan:, restore:) -\u003e ::String\n\nCreate a fully-qualified Restore resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **restore_plan** (String)\n- **restore** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #restore_plan_binding_path\n\n def restore_plan_binding_path(project:, location:, restore_channel:, restore_plan_binding:) -\u003e ::String\n\nCreate a fully-qualified RestorePlanBinding resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **restore_channel** (String)\n- **restore_plan_binding** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #restore_plan_path\n\n def restore_plan_path(project:, location:, restore_plan:) -\u003e ::String\n\nCreate a fully-qualified RestorePlan resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/restorePlans/{restore_plan}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **restore_plan** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #volume_backup_path\n\n def volume_backup_path(project:, location:, backup_plan:, backup:, volume_backup:) -\u003e ::String\n\nCreate a fully-qualified VolumeBackup resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **backup_plan** (String)\n- **backup** (String)\n- **volume_backup** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #volume_restore_path\n\n def volume_restore_path(project:, location:, restore_plan:, restore:, volume_restore:) -\u003e ::String\n\nCreate a fully-qualified VolumeRestore resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **restore_plan** (String)\n- **restore** (String)\n- **volume_restore** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)"]]