Discovery Engine V1 API - Module Google::Cloud::DiscoveryEngine::V1::DataStoreService::Paths (v2.3.0)

Reference documentation and code samples for the Discovery Engine V1 API module Google::Cloud::DiscoveryEngine::V1::DataStoreService::Paths.

Path helper methods for the DataStoreService API.

Methods

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

#data_store_path

def data_store_path(project:, location:, data_store:) -> ::String
def data_store_path(project:, location:, collection:, data_store:) -> ::String

Create a fully-qualified DataStore resource string.

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

projects/{project}/locations/{location}/dataStores/{data_store}

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

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

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

#document_processing_config_path

def document_processing_config_path(project:, location:, data_store:) -> ::String
def document_processing_config_path(project:, location:, collection:, data_store:) -> ::String

Create a fully-qualified DocumentProcessingConfig resource string.

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

projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig

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

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig

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

#identity_mapping_store_path

def identity_mapping_store_path(project:, location:, identity_mapping_store:) -> ::String

Create a fully-qualified IdentityMappingStore resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}

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

#schema_path

def schema_path(project:, location:, data_store:, schema:) -> ::String
def schema_path(project:, location:, collection:, data_store:, schema:) -> ::String

Create a fully-qualified Schema resource string.

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

projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}

Parameters
  • project (String)
  • location (String)
  • data_store (String)
  • schema (String)
def schema_path(project:, location:, collection:, data_store:, schema:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}

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