Discovery Engine V1BETA API - Module Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Paths (v0.21.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Discovery Engine V1BETA API module Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Paths.
Path helper methods for the UserEventService API.
Methods
#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)
#document_path
def document_path(project:, location:, data_store:, branch:, document:) -> ::String
def document_path(project:, location:, collection:, data_store:, branch:, document:) -> ::String
Create a fully-qualified Document resource string.
Overloads
def document_path(project:, location:, data_store:, branch:, document:) -> ::String
The resource will be in the following format:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
Parameters
-
project (String)
-
location (String)
-
data_store (String)
-
branch (String)
-
document (String)
def document_path(project:, location:, collection:, data_store:, branch:, document:) -> ::String
The resource will be in the following format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
Parameters
-
project (String)
-
location (String)
-
collection (String)
-
data_store (String)
-
branch (String)
-
document (String)
#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)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Module Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Paths (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths) \nReference documentation and code samples for the Discovery Engine V1BETA API module Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Paths.\n\nPath helper methods for the UserEventService API. \n\nExtended By\n-----------\n\n- [Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Paths](./Google-Cloud-DiscoveryEngine-V1beta-UserEventService-Paths)\n\nMethods\n-------\n\n### #data_store_path\n\n def data_store_path(project:, location:, data_store:) -\u003e ::String\n def data_store_path(project:, location:, collection:, data_store:) -\u003e ::String\n\nCreate a fully-qualified DataStore resource string. \n**Overloads** \n\n def data_store_path(project:, location:, data_store:) -\u003e ::String\n\nThe resource will be in the following format:\n\n\n`projects/{project}/locations/{location}/dataStores/{data_store}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **data_store** (String) \n\n def data_store_path(project:, location:, collection:, data_store:) -\u003e ::String\n\nThe resource will be in the following format:\n\n\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **collection** (String)\n- **data_store** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #document_path\n\n def document_path(project:, location:, data_store:, branch:, document:) -\u003e ::String\n def document_path(project:, location:, collection:, data_store:, branch:, document:) -\u003e ::String\n\nCreate a fully-qualified Document resource string. \n**Overloads** \n\n def document_path(project:, location:, data_store:, branch:, document:) -\u003e ::String\n\nThe resource will be in the following format:\n\n\n`projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **data_store** (String)\n- **branch** (String)\n- **document** (String) \n\n def document_path(project:, location:, collection:, data_store:, branch:, document:) -\u003e ::String\n\nThe resource will be in the following format:\n\n\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **collection** (String)\n- **data_store** (String)\n- **branch** (String)\n- **document** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #engine_path\n\n def engine_path(project:, location:, collection:, engine:) -\u003e ::String\n\nCreate a fully-qualified Engine resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **collection** (String)\n- **engine** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)"]]