2024-05-29
▼ ▲ discoveryengine.projects.provision
Path: v1/{+name}:provision
Flat Path: v1/projects/{projectsId}:provision
HTTP Method: POST
Parameters:
name
Description: Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.controls.create
Path: v1/{+parent}/controls
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls
HTTP Method: POST
Parameters:
parent
Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
controlId
Description: Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.controls.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.controls.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.controls.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Control.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.controls.list
Path: v1/{+parent}/controls
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls
HTTP Method: GET
Parameters:
parent
Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
Location: query
Type: string
filter
Description: Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Controls by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.collections.engines.controls.create
Path: v1/{+parent}/controls
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls
HTTP Method: POST
Parameters:
parent
Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
controlId
Description: Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.controls.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.controls.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.controls.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Control.
▼ ▲ discoveryengine.projects.locations.collections.engines.controls.list
Path: v1/{+parent}/controls
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls
HTTP Method: GET
Parameters:
parent
Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
Location: query
Type: string
filter
Description: Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Controls by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.controls.create
Path: v1/{+parent}/controls
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls
HTTP Method: POST
Parameters:
parent
Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
controlId
Description: Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.dataStores.controls.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.dataStores.controls.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.dataStores.controls.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Control.
▼ ▲ discoveryengine.projects.locations.dataStores.controls.list
Path: v1/{+parent}/controls
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls
HTTP Method: GET
Parameters:
parent
Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
Location: query
Type: string
filter
Description: Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Controls by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.write
Parameters:
writeAsync
Description: If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
Location: query
Type: boolean
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.write
Parameters:
writeAsync
Description: If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
Location: query
Type: boolean
▼ ▲ discoveryengine.projects.locations.userEvents.write
Parameters:
writeAsync
Description: If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
Location: query
Type: boolean