Discovery Engine V1BETA API - Module Google::Cloud::DiscoveryEngine::V1beta::DocumentService::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::DocumentService::Paths.
Path helper methods for the DocumentService API.
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)
#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)
#fhir_resource_path
def fhir_resource_path(project:, location:, dataset:, fhir_store:, resource_type:, fhir_resource_id:) -> ::String
Create a fully-qualified FhirResource resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
Parameters
-
project (String)
-
location (String)
-
dataset (String)
-
fhir_store (String)
-
resource_type (String)
-
fhir_resource_id (String)
#fhir_store_path
def fhir_store_path(project:, location:, dataset:, fhir_store:) -> ::String
Create a fully-qualified FhirStore resource string.
The resource will be in the following format:
projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}
Parameters
-
project (String)
-
location (String)
-
dataset (String)
-
fhir_store (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::DocumentService::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-DocumentService-Paths)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths) \nReference documentation and code samples for the Discovery Engine V1BETA API module Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Paths.\n\nPath helper methods for the DocumentService API. \n\nExtended By\n-----------\n\n- [Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Paths](./Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Paths)\n\nMethods\n-------\n\n### #branch_path\n\n def branch_path(project:, location:, data_store:, branch:) -\u003e ::String\n def branch_path(project:, location:, collection:, data_store:, branch:) -\u003e ::String\n\nCreate a fully-qualified Branch resource string. \n**Overloads** \n\n def branch_path(project:, location:, data_store:, branch:) -\u003e ::String\n\nThe resource will be in the following format:\n\n\n`projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **data_store** (String)\n- **branch** (String) \n\n def branch_path(project:, location:, collection:, data_store:, branch:) -\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}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **collection** (String)\n- **data_store** (String)\n- **branch** (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### #fhir_resource_path\n\n def fhir_resource_path(project:, location:, dataset:, fhir_store:, resource_type:, fhir_resource_id:) -\u003e ::String\n\nCreate a fully-qualified FhirResource resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **dataset** (String)\n- **fhir_store** (String)\n- **resource_type** (String)\n- **fhir_resource_id** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)\n\n### #fhir_store_path\n\n def fhir_store_path(project:, location:, dataset:, fhir_store:) -\u003e ::String\n\nCreate a fully-qualified FhirStore resource string.\n\n\nThe resource will be in the following format:\n\n\u003cbr /\u003e\n\n`projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}` \n**Parameters**\n\n- **project** (String)\n- **location** (String)\n- **dataset** (String)\n- **fhir_store** (String) \n**Returns**\n\n- (::String) \n**Raises**\n\n- (::ArgumentError)"]]
