Vector Search V1 API - Module Google::Cloud::VectorSearch::V1::VectorSearchService::Paths (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API module Google::Cloud::VectorSearch::V1::VectorSearchService::Paths.

Path helper methods for the VectorSearchService API.

Extended By

Included In

Methods

#collection_path

def collection_path(project:, location:, collection:) -> ::String

Create a fully-qualified Collection resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}

Parameters
  • project (String)
  • location (String)
  • collection (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)

#index_path

def index_path(project:, location:, collection:, index:) -> ::String

Create a fully-qualified Index resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/indexes/{index}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • index (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)