Backup for GKE V1 API - Module Google::Cloud::GkeBackup::V1::BackupForGKE::Paths (v0.4.0)

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.

Extended By

Methods

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)