Cloud Key Management Service (KMS) V1 API - Module Google::Cloud::Kms::V1::KeyManagementService::Paths (v1.7.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API module Google::Cloud::Kms::V1::KeyManagementService::Paths.
Path helper methods for the KeyManagementService API.
Methods
#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)
#crypto_key_version_path
def crypto_key_version_path(project:, location:, key_ring:, crypto_key:, crypto_key_version:) -> ::String
Create a fully-qualified CryptoKeyVersion resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
Parameters
-
project (String)
-
location (String)
-
key_ring (String)
-
crypto_key (String)
-
crypto_key_version (String)
#import_job_path
def import_job_path(project:, location:, key_ring:, import_job:) -> ::String
Create a fully-qualified ImportJob resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}
Parameters
-
project (String)
-
location (String)
-
key_ring (String)
-
import_job (String)
#key_ring_path
def key_ring_path(project:, location:, key_ring:) -> ::String
Create a fully-qualified KeyRing resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/keyRings/{key_ring}
Parameters
-
project (String)
-
location (String)
-
key_ring (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)
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,["# Cloud Key Management Service (KMS) V1 API - Module Google::Cloud::Kms::V1::KeyManagementService::Paths (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.6.0](/ruby/docs/reference/google-cloud-kms-v1/1.6.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.5.1](/ruby/docs/reference/google-cloud-kms-v1/1.5.1/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.4.0](/ruby/docs/reference/google-cloud-kms-v1/1.4.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.3.2](/ruby/docs/reference/google-cloud-kms-v1/1.3.2/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.2.1](/ruby/docs/reference/google-cloud-kms-v1/1.2.1/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.1.0](/ruby/docs/reference/google-cloud-kms-v1/1.1.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [1.0.2](/ruby/docs/reference/google-cloud-kms-v1/1.0.2/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.27.0](/ruby/docs/reference/google-cloud-kms-v1/0.27.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.26.0](/ruby/docs/reference/google-cloud-kms-v1/0.26.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.25.1](/ruby/docs/reference/google-cloud-kms-v1/0.25.1/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.24.3](/ruby/docs/reference/google-cloud-kms-v1/0.24.3/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.23.0](/ruby/docs/reference/google-cloud-kms-v1/0.23.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.22.1](/ruby/docs/reference/google-cloud-kms-v1/0.22.1/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.21.0](/ruby/docs/reference/google-cloud-kms-v1/0.21.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.20.0](/ruby/docs/reference/google-cloud-kms-v1/0.20.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.19.0](/ruby/docs/reference/google-cloud-kms-v1/0.19.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.18.1](/ruby/docs/reference/google-cloud-kms-v1/0.18.1/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.17.0](/ruby/docs/reference/google-cloud-kms-v1/0.17.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.16.0](/ruby/docs/reference/google-cloud-kms-v1/0.16.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.15.0](/ruby/docs/reference/google-cloud-kms-v1/0.15.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.14.0](/ruby/docs/reference/google-cloud-kms-v1/0.14.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.13.0](/ruby/docs/reference/google-cloud-kms-v1/0.13.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.12.0](/ruby/docs/reference/google-cloud-kms-v1/0.12.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.11.0](/ruby/docs/reference/google-cloud-kms-v1/0.11.0/Google-Cloud-Kms-V1-KeyManagementService-Paths)\n- [0.10.2](/ruby/docs/reference/google-cloud-kms-v1/0.10.2/Google-Cloud-Kms-V1-KeyManagementService-Paths) \nReference documentation and code samples for the Cloud Key Management Service (KMS) V1 API module Google::Cloud::Kms::V1::KeyManagementService::Paths.\n\nPath helper methods for the KeyManagementService API. \n\nExtended By\n-----------\n\n- [Google::Cloud::Kms::V1::KeyManagementService::Paths](./Google-Cloud-Kms-V1-KeyManagementService-Paths)\n\nMethods\n-------\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### #crypto_key_version_path\n\n def crypto_key_version_path(project:, location:, key_ring:, crypto_key:, crypto_key_version:) -\u003e ::String\n\nCreate a fully-qualified CryptoKeyVersion 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}/cryptoKeyVersions/{crypto_key_version}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **key_ring** (String)\n- **crypto_key** (String)\n- **crypto_key_version** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #import_job_path\n\n def import_job_path(project:, location:, key_ring:, import_job:) -\u003e ::String\n\nCreate a fully-qualified ImportJob 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}/importJobs/{import_job}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **key_ring** (String)\n- **import_job** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #key_ring_path\n\n def key_ring_path(project:, location:, key_ring:) -\u003e ::String\n\nCreate a fully-qualified KeyRing 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}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **key_ring** (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)"]]