DataConnector(mapping=None, *, ignore_unknown_fields=False, **kwargs)Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
params |
google.protobuf.struct_pb2.Struct
Required data connector parameters in structured json format. This field is a member of oneof_ data_connector_params.
|
json_params |
str
Required data connector parameters in json string format. This field is a member of oneof_ data_connector_params.
|
name |
str
Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.
|
state |
google.cloud.discoveryengine_v1.types.DataConnector.State
Output only. State of the connector. |
data_source |
str
Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see `Connect a third-party data source |
remove_param_keys |
MutableSequence[str]
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. |
refresh_interval |
google.protobuf.duration_pb2.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. |
next_sync_time |
google.type.datetime_pb2.DateTime
Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the `IANA Time Zone Database |
entities |
MutableSequence[google.cloud.discoveryengine_v1.types.DataConnector.SourceEntity]
List of entities from the connected data source to ingest. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the DataConnector was created at. |
latest_pause_time |
google.protobuf.timestamp_pb2.Timestamp
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. |
last_sync_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. For periodic connectors only, the last time a data sync was completed. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the DataConnector was last updated. |
errors |
MutableSequence[google.rpc.status_pb2.Status]
Output only. The errors from initialization or from the latest connector run. |
sync_mode |
google.cloud.discoveryengine_v1.types.DataConnector.SyncMode
The data synchronization mode supported by the data connector. |
kms_key_name |
str
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. |
destination_configs |
MutableSequence[google.cloud.discoveryengine_v1.types.DestinationConfig]
Optional. Any target destinations used to connect to third-party services. |
action_state |
google.cloud.discoveryengine_v1.types.DataConnector.State
Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. |
action_config |
google.cloud.discoveryengine_v1.types.ActionConfig
Optional. Action configurations to make the connector support actions. |
end_user_config |
google.cloud.discoveryengine_v1.types.DataConnector.EndUserConfig
Optional. Any params and credentials used specifically for EUA connectors. |
federated_config |
google.cloud.discoveryengine_v1.types.DataConnector.FederatedConfig
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. |
connector_modes |
MutableSequence[google.cloud.discoveryengine_v1.types.DataConnector.ConnectorMode]
Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. |
static_ip_enabled |
bool
Optional. Whether customer has enabled static IP addresses for this connector. |
static_ip_addresses |
MutableSequence[str]
Output only. The static IP addresses used by this connector. |
oauth_static_ip_addresses |
MutableSequence[str]
Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that
customers can apply granular firewall settings for OAuth
endpoints. Only populated for connectors that have static IP
enabled and are used for actions and/or federated search.
|
blocking_reasons |
MutableSequence[google.cloud.discoveryengine_v1.types.DataConnector.BlockingReason]
Output only. User actions that must be completed before the connector can start syncing data. |
identity_schedule_config |
google.cloud.discoveryengine_v1.types.IdentityScheduleConfig
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. |
private_connectivity_project_id |
str
Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. |
bap_config |
google.cloud.discoveryengine_v1.types.BAPConfig
Optional. The configuration for establishing a BAP connection. |
connector_type |
google.cloud.discoveryengine_v1.types.ConnectorType
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. |
realtime_state |
google.cloud.discoveryengine_v1.types.DataConnector.State
Output only. real-time sync state |
alert_policy_configs |
MutableSequence[google.cloud.discoveryengine_v1.types.AlertPolicyConfig]
Optional. The connector level alert config. |
realtime_sync_config |
google.cloud.discoveryengine_v1.types.DataConnector.RealtimeSyncConfig
Optional. The configuration for realtime sync. |
acl_enabled |
bool
Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. |
create_eua_saas |
bool
Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. |
auto_run_disabled |
bool
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 |
incremental_sync_disabled |
bool
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. |
incremental_refresh_interval |
google.protobuf.duration_pb2.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. |
hybrid_ingestion_disabled |
bool
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. |
data_protection_policy |
google.cloud.discoveryengine_v1.types.DataProtectionPolicy
Optional. Specifies the data protection policy for the connector. |
egress_fqdns |
MutableSequence[str]
Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. |
vpcsc_enabled |
bool
Output only. Whether the connector is created with VPC-SC enabled. |
dynamic_tools |
MutableSequence[google.cloud.discoveryengine_v1.types.DynamicTool]
Output only. The dynamic tools fetched for this connector. |
cli_config |
google.cloud.discoveryengine_v1.types.CliConfig
Optional. The configuration for establishing a CLI connection. |
connector_source_id |
str
Optional. If set, this value instead of data_source is
used to fetch the corresponding connector source.
|
tag |
str
Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits tag, the
server auto-derives one from the collection_id (falling back
to data_source, else a time-based t- sentinel).
The auto-derived tag is subject to the same immutability
guarantee as a caller-supplied one, so callers who care
about the exact tag value should provide it explicitly
rather than relying on the server default.
Agent Designer resolves connectors via (data_source, tag)
when set, falling back to the legacy resource-name lookup
when unset, so connectors created before the tag-write
launch continue to work without a backfill.
|
metadata |
google.cloud.discoveryengine_v1.types.DataConnector.ConnectorMetadata
Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.
|
Classes
BlockingReason
BlockingReason(value)User actions that must be completed before the connector can start syncing data.
ConnectorMetadata
ConnectorMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
ConnectorMode
ConnectorMode(value)The modes enabled for this connector. INGESTION, ACTIONS, FEDERATED, OR EUA
EndUserConfig
EndUserConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Any params and credentials used specifically for EUA connectors.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FederatedConfig
FederatedConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RealtimeSyncConfig
RealtimeSyncConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)The configuration for realtime sync to store additional params for realtime sync.
SourceEntity
SourceEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents an entity in the data source. For example, the
Account object in Salesforce.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
State(value)The state of connector.
SyncMode
SyncMode(value)Defines the data synchronization mode supported by the data connector.