Discovery Engine V1 API - Module Google::Cloud::DiscoveryEngine::V1::DocumentService::Paths (v1.4.0)

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

Path helper methods for the DocumentService 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)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#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)
Returns
  • (::String)
Raises
  • (::ArgumentError)