collections_data_connector

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

Overview

Name	collections_data_connector
Type	Resource
Id	google.discoveryengine.collections_data_connector

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_get_data_connector

Name	Datatype	Description
name	string	Output only. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.
aclEnabled	boolean	Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
actionConfig	object	Optional. Action configurations to make the connector support actions. (id: GoogleCloudDiscoveryengineV1ActionConfig)
actionState	string	Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
alertPolicyConfigs	array	Optional. The connector level alert config.
autoRunDisabled	boolean	Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
bapConfig	object	Optional. The configuration for establishing a BAP connection. (id: GoogleCloudDiscoveryengineV1BAPConfig)
blockingReasons	array	Output only. User actions that must be completed before the connector can start syncing data.
connectorModes	array	Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
connectorType	string	Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
createEuaSaas	boolean	Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
createTime	string (google-datetime)	Output only. Timestamp the DataConnector was created at.
dataSource	string	Required. The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
destinationConfigs	array	Optional. Any target destinations used to connect to third-party services.
endUserConfig	object	Optional. Any params and credentials used specifically for EUA connectors. (id: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig)
entities	array	List of entities from the connected data source to ingest.
errors	array	Output only. The errors from initialization or from the latest connector run.
federatedConfig	object	Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. (id: GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig)
hybridIngestionDisabled	boolean	Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
identityRefreshInterval	string (google-duration)	The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
identityScheduleConfig	object	The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. (id: GoogleCloudDiscoveryengineV1IdentityScheduleConfig)
incrementalRefreshInterval	string (google-duration)	Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
incrementalSyncDisabled	boolean	Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
jsonParams	string	Required data connector parameters in json string format.
kmsKeyName	string	Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
lastSyncTime	string (google-datetime)	Output only. For periodic connectors only, the last time a data sync was completed.
latestPauseTime	string (google-datetime)	Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
nextSyncTime	object	Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. (id: GoogleTypeDateTime)
params	object	Required data connector parameters in structured json format.
privateConnectivityProjectId	string	Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
realtimeState	string	Output only. real-time sync state
realtimeSyncConfig	object	Optional. The configuration for realtime sync. (id: GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig)
refreshInterval	string (google-duration)	Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
removeParamKeys	array	Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
state	string	Output only. State of the connector.
staticIpAddresses	array	Output only. The static IP addresses used by this connector.
staticIpEnabled	boolean	Optional. Whether customer has enabled static IP addresses for this connector.
syncMode	string	The data synchronization mode supported by the data connector.
updateTime	string (google-datetime)	Output only. Timestamp the DataConnector was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_get_data_connector	select	projectsId, locationsId, collectionsId		Gets the DataConnector. DataConnector is a singleton resource for each Collection.
projects_locations_collections_update_data_connector	update	projectsId, locationsId, collectionsId	updateMask	Updates a DataConnector.

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
collectionsId	string
locationsId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_collections_get_data_connector

Gets the DataConnector. DataConnector is a singleton resource for each Collection.

SELECT
name,
aclEnabled,
actionConfig,
actionState,
alertPolicyConfigs,
autoRunDisabled,
bapConfig,
blockingReasons,
connectorModes,
connectorType,
createEuaSaas,
createTime,
dataSource,
destinationConfigs,
endUserConfig,
entities,
errors,
federatedConfig,
hybridIngestionDisabled,
identityRefreshInterval,
identityScheduleConfig,
incrementalRefreshInterval,
incrementalSyncDisabled,
jsonParams,
kmsKeyName,
lastSyncTime,
latestPauseTime,
nextSyncTime,
params,
privateConnectivityProjectId,
realtimeState,
realtimeSyncConfig,
refreshInterval,
removeParamKeys,
state,
staticIpAddresses,
staticIpEnabled,
syncMode,
updateTime
FROM google.discoveryengine.collections_data_connector
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
;

UPDATE examples

projects_locations_collections_update_data_connector

Updates a DataConnector.

UPDATE google.discoveryengine.collections_data_connector
SET 
data__incrementalSyncDisabled = {{ incrementalSyncDisabled }},
data__kmsKeyName = '{{ kmsKeyName }}',
data__staticIpEnabled = {{ staticIpEnabled }},
data__endUserConfig = '{{ endUserConfig }}',
data__aclEnabled = {{ aclEnabled }},
data__incrementalRefreshInterval = '{{ incrementalRefreshInterval }}',
data__connectorModes = '{{ connectorModes }}',
data__syncMode = '{{ syncMode }}',
data__nextSyncTime = '{{ nextSyncTime }}',
data__alertPolicyConfigs = '{{ alertPolicyConfigs }}',
data__realtimeSyncConfig = '{{ realtimeSyncConfig }}',
data__identityRefreshInterval = '{{ identityRefreshInterval }}',
data__dataSource = '{{ dataSource }}',
data__entities = '{{ entities }}',
data__jsonParams = '{{ jsonParams }}',
data__hybridIngestionDisabled = {{ hybridIngestionDisabled }},
data__bapConfig = '{{ bapConfig }}',
data__autoRunDisabled = {{ autoRunDisabled }},
data__destinationConfigs = '{{ destinationConfigs }}',
data__removeParamKeys = '{{ removeParamKeys }}',
data__createEuaSaas = {{ createEuaSaas }},
data__federatedConfig = '{{ federatedConfig }}',
data__refreshInterval = '{{ refreshInterval }}',
data__params = '{{ params }}',
data__actionConfig = '{{ actionConfig }}',
data__identityScheduleConfig = '{{ identityScheduleConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
aclEnabled,
actionConfig,
actionState,
alertPolicyConfigs,
autoRunDisabled,
bapConfig,
blockingReasons,
connectorModes,
connectorType,
createEuaSaas,
createTime,
dataSource,
destinationConfigs,
endUserConfig,
entities,
errors,
federatedConfig,
hybridIngestionDisabled,
identityRefreshInterval,
identityScheduleConfig,
incrementalRefreshInterval,
incrementalSyncDisabled,
jsonParams,
kmsKeyName,
lastSyncTime,
latestPauseTime,
nextSyncTime,
params,
privateConnectivityProjectId,
realtimeState,
realtimeSyncConfig,
refreshInterval,
removeParamKeys,
state,
staticIpAddresses,
staticIpEnabled,
syncMode,
updateTime;