2023-11-08
▼ ▲ discoveryengine.projects.locations.collections.dataStores.create
Path: v1alpha/{+parent}/dataStores
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
dataStoreId
Description: Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
createAdvancedSiteSearch
Description: A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.list
Path: v1alpha/{+parent}/dataStores
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores
HTTP Method: GET
Parameters:
parent
Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
filter
Description: Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all the DataStores associated with the project.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}
HTTP Method: PATCH
Parameters:
name
Description: 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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a DataStore
▼ ▲ discoveryengine.projects.locations.collections.engines.create
Path: v1alpha/{+parent}/engines
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
engineId
Description: Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an Engine
▼ ▲ discoveryengine.projects.locations.collections.engines.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.list
Path: v1alpha/{+parent}/engines
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines
HTTP Method: GET
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Not supported.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Not supported.
Location: query
Type: string
filter
Description: Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all the Engines associated with the project.
▼ ▲ discoveryengine.projects.locations.collections.engines.pause
Path: v1alpha/{+name}:pause
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:pause
HTTP Method: POST
Parameters:
name
Description: Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Pauses the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
▼ ▲ discoveryengine.projects.locations.collections.engines.resume
Path: v1alpha/{+name}:resume
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:resume
HTTP Method: POST
Parameters:
name
Description: Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Resumes the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
▼ ▲ discoveryengine.projects.locations.collections.engines.tune
Path: v1alpha/{+name}:tune
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:tune
HTTP Method: POST
Parameters:
name
Description: Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Tunes an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
▼ ▲ discoveryengine.projects.locations.dataStores.create
Path: v1alpha/{+parent}/dataStores
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
dataStoreId
Description: Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
createAdvancedSiteSearch
Description: A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ discoveryengine.projects.locations.dataStores.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.list
Path: v1alpha/{+parent}/dataStores
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores
HTTP Method: GET
Parameters:
parent
Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
filter
Description: Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all the DataStores associated with the project.
▼ ▲ discoveryengine.projects.locations.dataStores.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}
HTTP Method: PATCH
Parameters:
name
Description: 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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a DataStore