Discovery Engine V1BETA API - Module Google::Cloud::DiscoveryEngine::V1beta::EngineService::Paths (v0.28.0)

Reference documentation and code samples for the Discovery Engine V1BETA API module Google::Cloud::DiscoveryEngine::V1beta::EngineService::Paths.

Path helper methods for the EngineService API.

Extended By

Included In

Methods

#agent_gateway_path

def agent_gateway_path(project:, location:, agent_gateway:) -> ::String

Create a fully-qualified AgentGateway resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agentGateways/{agent_gateway}

Parameters
  • project (String)
  • location (String)
  • agent_gateway (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#cmek_config_path

def cmek_config_path(project:, location:) -> ::String
def cmek_config_path(project:, location:, cmek_config:) -> ::String

Create a fully-qualified CmekConfig resource string.

Overloads 
def cmek_config_path(project:, location:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/cmekConfig

Parameters
  • project (String)
  • location (String) 
def cmek_config_path(project:, location:, cmek_config:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/cmekConfigs/{cmek_config}

Parameters
  • project (String)
  • location (String)
  • cmek_config (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

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

def crypto_key_versions_path(project:, location:, key_ring:, crypto_key:, crypto_key_version:) -> ::String

Create a fully-qualified CryptoKeyVersions 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)

#crypto_keys_path

def crypto_keys_path(project:, location:, key_ring:, crypto_key:) -> ::String

Create a fully-qualified CryptoKeys 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)

#engine_path

def engine_path(project:, location:, collection:, engine:) -> ::String

Create a fully-qualified Engine resource string.

The resource will be in the following format:

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

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • engine (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)