locations

Creates, updates, deletes, gets or lists a locations resource.

Overview

Name	locations
Type	Resource
Id	google.discoveryengine.locations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_provision	exec	projectsId, locationsId		Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the Terms for data use, and optionally specify in request to provide consent to that service terms.
projects_locations_set_up_data_connector	exec	projectsId, locationsId		Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
projects_locations_set_up_data_connector_v2	exec	projectsId, locationsId	collectionDisplayName, collectionId	Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
collectionDisplayName	string
collectionId	string

Lifecycle Methods

projects_locations_provision

Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the Terms for data use, and optionally specify in request to provide consent to that service terms.

EXEC google.discoveryengine.locations.projects_locations_provision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"acceptDataUseTerms": {{ acceptDataUseTerms }}, 
"dataUseTermsVersion": "{{ dataUseTermsVersion }}", 
"saasParams": "{{ saasParams }}"
}'
;

projects_locations_set_up_data_connector

Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

EXEC google.discoveryengine.locations.projects_locations_set_up_data_connector 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"collectionDisplayName": "{{ collectionDisplayName }}", 
"collectionId": "{{ collectionId }}", 
"dataConnector": "{{ dataConnector }}"
}'
;

projects_locations_set_up_data_connector_v2

Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

EXEC google.discoveryengine.locations.projects_locations_set_up_data_connector_v2 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionDisplayName='{{ collectionDisplayName }}', 
@collectionId='{{ collectionId }}' 
@@json=
'{
"aclEnabled": {{ aclEnabled }}, 
"actionConfig": "{{ actionConfig }}", 
"alertPolicyConfigs": "{{ alertPolicyConfigs }}", 
"autoRunDisabled": {{ autoRunDisabled }}, 
"bapConfig": "{{ bapConfig }}", 
"cliConfig": "{{ cliConfig }}", 
"connectorModes": "{{ connectorModes }}", 
"connectorSourceId": "{{ connectorSourceId }}", 
"createEuaSaas": {{ createEuaSaas }}, 
"dataSource": "{{ dataSource }}", 
"destinationConfigs": "{{ destinationConfigs }}", 
"endUserConfig": "{{ endUserConfig }}", 
"entities": "{{ entities }}", 
"federatedConfig": "{{ federatedConfig }}", 
"hybridIngestionDisabled": {{ hybridIngestionDisabled }}, 
"identityRefreshInterval": "{{ identityRefreshInterval }}", 
"identityScheduleConfig": "{{ identityScheduleConfig }}", 
"incrementalRefreshInterval": "{{ incrementalRefreshInterval }}", 
"incrementalSyncDisabled": {{ incrementalSyncDisabled }}, 
"jsonParams": "{{ jsonParams }}", 
"kmsKeyName": "{{ kmsKeyName }}", 
"metadata": "{{ metadata }}", 
"name": "{{ name }}", 
"nextSyncTime": "{{ nextSyncTime }}", 
"params": "{{ params }}", 
"realtimeSyncConfig": "{{ realtimeSyncConfig }}", 
"refreshInterval": "{{ refreshInterval }}", 
"removeParamKeys": "{{ removeParamKeys }}", 
"staticIpEnabled": {{ staticIpEnabled }}, 
"syncMode": "{{ syncMode }}", 
"tag": "{{ tag }}"
}'
;