AlloyDB V1 API - Module Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Paths (v0.7.0)

Reference documentation and code samples for the AlloyDB V1 API module Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Paths.

Path helper methods for the AlloyDBAdmin API.

Extended By

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

#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)
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)

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

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