AlloyDB V1ALPHA API - Module Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Paths (v0.14.1)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the AlloyDB V1ALPHA API module Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Paths.
Path helper methods for the AlloyDBAdmin API.
Methods
#backup_path
def backup_path(project:, location:, backup:) -> ::String
Create a fully-qualified Backup resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/backups/{backup}
Parameters
-
project (String)
-
location (String)
-
backup (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_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)
#instance_path
def instance_path(project:, location:, cluster:, instance:) -> ::String
Create a fully-qualified Instance resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
Parameters
-
project (String)
-
location (String)
-
cluster (String)
-
instance (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)
#network_path
def network_path(project:, network:) -> ::String
Create a fully-qualified Network resource string.
The resource will be in the following format:
projects/{project}/global/networks/{network}
Parameters
-
project (String)
-
network (String)
#user_path
def user_path(project:, location:, cluster:, user:) -> ::String
Create a fully-qualified User resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/clusters/{cluster}/users/{user}
Parameters
-
project (String)
-
location (String)
-
cluster (String)
-
user (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,["# AlloyDB V1ALPHA API - Module Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Paths (v0.14.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.14.1 (latest)](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/latest/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.14.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.14.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.13.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.13.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.12.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.12.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.11.1](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.11.1/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.10.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.10.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.9.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.9.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.8.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.8.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.7.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.7.2/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.6.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.6.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.5.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.5.2/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.4.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.4.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.3.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.2.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n- [0.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.1.0/Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths) \nReference documentation and code samples for the AlloyDB V1ALPHA API module Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Paths.\n\nPath helper methods for the AlloyDBAdmin API. \n\nExtended By\n-----------\n\n- [Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Paths](./Google-Cloud-AlloyDB-V1alpha-AlloyDBAdmin-Paths)\n\nMethods\n-------\n\n### #backup_path\n\n def backup_path(project:, location:, 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}/backups/{backup}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **backup** (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_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### #instance_path\n\n def instance_path(project:, location:, cluster:, instance:) -\u003e ::String\n\nCreate a fully-qualified Instance resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **cluster** (String)\n- **instance** (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### #network_path\n\n def network_path(project:, network:) -\u003e ::String\n\nCreate a fully-qualified Network resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/global/networks/{network}` \n**Parameters**\n\n- **project** (String)\n- **network** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #user_path\n\n def user_path(project:, location:, cluster:, user:) -\u003e ::String\n\nCreate a fully-qualified User resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/clusters/{cluster}/users/{user}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **cluster** (String)\n- **user** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)"]]