1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCollectionsDataStores

ProjectsLocationsCollectionsDataStores

class ProjectsLocationsCollectionsDataStores extends Resource (View source)

The "dataStores" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $dataStores = $discoveryengineService->projects_locations_collections_dataStores;

Methods

GoogleCloudDiscoveryengineV1CompleteQueryResponse
completeQuery(string $dataStore, array $optParams = [])

Completes the specified user input with keyword suggestions.

GoogleLongrunningOperation
create(string $parent, GoogleCloudDiscoveryengineV1DataStore $postBody, array $optParams = [])

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. (dataStores.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes a DataStore. (dataStores.delete)

GoogleCloudDiscoveryengineV1DataStore
get(string $name, array $optParams = [])

Gets a DataStore. (dataStores.get)

GoogleCloudDiscoveryengineV1SiteSearchEngine
getSiteSearchEngine(string $name, array $optParams = [])

Gets the SiteSearchEngine. (dataStores.getSiteSearchEngine)

GoogleCloudDiscoveryengineV1ListDataStoresResponse
listProjectsLocationsCollectionsDataStores(string $parent, array $optParams = [])

Lists all the DataStores associated with the project.

GoogleCloudDiscoveryengineV1DataStore
patch(string $name, GoogleCloudDiscoveryengineV1DataStore $postBody, array $optParams = [])

Updates a DataStore (dataStores.patch)

Details

at line 73
GoogleCloudDiscoveryengineV1CompleteQueryResponse completeQuery(string $dataStore, array $optParams = [])

Completes the specified user input with keyword suggestions.

(dataStores.completeQuery)

Parameters

string $dataStore

Required. The parent data store resource name for which the completion is performed, such as projects/locations/global/collect ions/default_collection/dataStores/default_data_store.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1CompleteQueryResponse

Exceptions

Exception

at line 107
GoogleLongrunningOperation create(string $parent, GoogleCloudDiscoveryengineV1DataStore $postBody, array $optParams = [])

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. (dataStores.create)

Parameters

string $parent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.
GoogleCloudDiscoveryengineV1DataStore $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 126
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a DataStore. (dataStores.delete)

Parameters

string $name

Required. Full resource name of DataStore, such as proje cts/{project}/locations/{location}/collections/{collection_id}/dataStores/{da ta_store_id}. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 145
GoogleCloudDiscoveryengineV1DataStore get(string $name, array $optParams = [])

Gets a DataStore. (dataStores.get)

Parameters

string $name

Required. Full resource name of DataStore, such as proje cts/{project}/locations/{location}/collections/{collection_id}/dataStores/{da ta_store_id}. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1DataStore

Exceptions

Exception

at line 163
GoogleCloudDiscoveryengineV1SiteSearchEngine getSiteSearchEngine(string $name, array $optParams = [])

Gets the SiteSearchEngine. (dataStores.getSiteSearchEngine)

Parameters

string $name

Required. Resource name of SiteSearchEngine, such as pro jects/{project}/locations/{location}/collections/{collection}/dataStores/{dat a_store}/siteSearchEngine. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1SiteSearchEngine

Exceptions

Exception

at line 195
GoogleCloudDiscoveryengineV1ListDataStoresResponse listProjectsLocationsCollectionsDataStores(string $parent, array $optParams = [])

Lists all the DataStores associated with the project.

(dataStores.listProjectsLocationsCollectionsDataStores)

Parameters

string $parent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListDataStoresResponse

Exceptions

Exception

at line 217
GoogleCloudDiscoveryengineV1DataStore patch(string $name, GoogleCloudDiscoveryengineV1DataStore $postBody, array $optParams = [])

Updates a DataStore (dataStores.patch)

Parameters

string $name

Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/ dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
GoogleCloudDiscoveryengineV1DataStore $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1DataStore

Exceptions

Exception