Discovery Engine V1 API - Module Google::Cloud::DiscoveryEngine::V1::SearchService::Paths (v1.3.0)

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

Path helper methods for the SearchService API.

Extended By

Methods

#branch_path

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

Create a fully-qualified Branch resource string.

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

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

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

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

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

#serving_config_path

def serving_config_path(project:, location:, data_store:, serving_config:) -> ::String
def serving_config_path(project:, location:, collection:, data_store:, serving_config:) -> ::String
def serving_config_path(project:, location:, collection:, engine:, serving_config:) -> ::String

Create a fully-qualified ServingConfig resource string.

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

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

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

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

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

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

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

#session_path

def session_path(project:, location:, data_store:, session:) -> ::String
def session_path(project:, location:, collection:, data_store:, session:) -> ::String
def session_path(project:, location:, collection:, engine:, session:) -> ::String

Create a fully-qualified Session resource string.

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

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

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

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

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

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

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