Discovery Engine v1 API - Class DataConnector (1.17.0) 

public sealed class DataConnector : IMessage<DataConnector>, IEquatable<DataConnector>, IDeepCloneable<DataConnector>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class DataConnector.

Manages the connection to external data sources for all data stores grouped under a [Collection][google.cloud.discoveryengine.v1.Collection]. It's a singleton resource of [Collection][google.cloud.discoveryengine.v1.Collection]. The initialization is only supported through [DataConnectorService.SetUpDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.SetUpDataConnector] method, which will create a new [Collection][google.cloud.discoveryengine.v1.Collection] and initialize its [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Inheritance

object > DataConnector

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DataConnector()

public DataConnector()

DataConnector(DataConnector)

public DataConnector(DataConnector other)
Parameter
Name Description
other DataConnector

Properties

AclEnabled

public bool AclEnabled { get; set; }

Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.

Property Value
Type Description
bool

ActionConfig

public ActionConfig ActionConfig { get; set; }

Optional. Action configurations to make the connector support actions.

Property Value
Type Description
ActionConfig

ActionState

public DataConnector.Types.State ActionState { get; set; }

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.

Property Value
Type Description
DataConnectorTypesState

AlertPolicyConfigs

public RepeatedField<AlertPolicyConfig> AlertPolicyConfigs { get; }

Optional. The connector level alert config.

Property Value
Type Description
RepeatedFieldAlertPolicyConfig

AutoRunDisabled

public bool AutoRunDisabled { get; set; }

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

Property Value
Type Description
bool

BapConfig

public BAPConfig BapConfig { get; set; }

Optional. The configuration for establishing a BAP connection.

Property Value
Type Description
BAPConfig

BlockingReasons

public RepeatedField<DataConnector.Types.BlockingReason> BlockingReasons { get; }

Output only. User actions that must be completed before the connector can start syncing data.

Property Value
Type Description
RepeatedFieldDataConnectorTypesBlockingReason

CliConfig

public CliConfig CliConfig { get; set; }

Optional. The configuration for establishing a CLI connection.

Property Value
Type Description
CliConfig

ConnectorModes

public RepeatedField<DataConnector.Types.ConnectorMode> ConnectorModes { get; }

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

Property Value
Type Description
RepeatedFieldDataConnectorTypesConnectorMode

ConnectorSourceId

public string ConnectorSourceId { get; set; }

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

Property Value
Type Description
string

ConnectorType

public ConnectorType ConnectorType { get; set; }

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.

Property Value
Type Description
ConnectorType

CreateEuaSaas

public bool CreateEuaSaas { get; set; }

Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.

Property Value
Type Description
bool

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] was created at.

Property Value
Type Description
Timestamp

DataConnectorName

public DataConnectorName DataConnectorName { get; set; }

DataConnectorName-typed view over the Name resource name property.

Property Value
Type Description
DataConnectorName

DataConnectorParamsCase

public DataConnector.DataConnectorParamsOneofCase DataConnectorParamsCase { get; }
Property Value
Type Description
DataConnectorDataConnectorParamsOneofCase

DataProtectionPolicy

public DataProtectionPolicy DataProtectionPolicy { get; set; }

Optional. Specifies the data protection policy for the connector.

Property Value
Type Description
DataProtectionPolicy

DataSource

public string DataSource { get; set; }

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.

Property Value
Type Description
string

DestinationConfigs

public RepeatedField<DestinationConfig> DestinationConfigs { get; }

Optional. Any target destinations used to connect to third-party services.

Property Value
Type Description
RepeatedFieldDestinationConfig

DynamicTools

public RepeatedField<DynamicTool> DynamicTools { get; }

Output only. The dynamic tools fetched for this connector.

Property Value
Type Description
RepeatedFieldDynamicTool

EgressFqdns

public RepeatedField<string> EgressFqdns { get; }

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.

Property Value
Type Description
RepeatedFieldstring

EndUserConfig

public DataConnector.Types.EndUserConfig EndUserConfig { get; set; }

Optional. Any params and credentials used specifically for EUA connectors.

Property Value
Type Description
DataConnectorTypesEndUserConfig

Entities

public RepeatedField<DataConnector.Types.SourceEntity> Entities { get; }

List of entities from the connected data source to ingest.

Property Value
Type Description
RepeatedFieldDataConnectorTypesSourceEntity

Errors

public RepeatedField<Status> Errors { get; }

Output only. The errors from initialization or from the latest connector run.

Property Value
Type Description
RepeatedFieldStatus

FederatedConfig

public DataConnector.Types.FederatedConfig FederatedConfig { get; set; }

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.

Property Value
Type Description
DataConnectorTypesFederatedConfig

HasJsonParams

public bool HasJsonParams { get; }

Gets whether the "json_params" field is set

Property Value
Type Description
bool

HybridIngestionDisabled

public bool HybridIngestionDisabled { get; set; }

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.

Property Value
Type Description
bool

IdentityScheduleConfig

public IdentityScheduleConfig IdentityScheduleConfig { get; set; }

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.

Property Value
Type Description
IdentityScheduleConfig

IncrementalRefreshInterval

public Duration IncrementalRefreshInterval { get; set; }

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.

Property Value
Type Description
Duration

IncrementalSyncDisabled

public bool IncrementalSyncDisabled { get; set; }

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.

Property Value
Type Description
bool

JsonParams

public string JsonParams { get; set; }

Required data connector parameters in json string format.

Property Value
Type Description
string

KmsKeyName

public string KmsKeyName { get; set; }

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.

Property Value
Type Description
string

LastSyncTime

public Timestamp LastSyncTime { get; set; }

Output only. For periodic connectors only, the last time a data sync was completed.

Property Value
Type Description
Timestamp

LatestPauseTime

public Timestamp LatestPauseTime { get; set; }

Output only. The most recent timestamp when this [DataConnector][google.cloud.discoveryengine.v1.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.
Property Value
Type Description
Timestamp

Metadata

public DataConnector.Types.ConnectorMetadata Metadata { get; set; }

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

Property Value
Type Description
DataConnectorTypesConnectorMetadata

Name

public string Name { get; set; }

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

Property Value
Type Description
string

NextSyncTime

public DateTime NextSyncTime { get; set; }

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.

Property Value
Type Description
DateTime

OauthStaticIpAddresses

public RepeatedField<string> OauthStaticIpAddresses { get; }

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.

Property Value
Type Description
RepeatedFieldstring

Params

public Struct Params { get; set; }

Required data connector parameters in structured json format.

Property Value
Type Description
Struct

PrivateConnectivityProjectId

public string PrivateConnectivityProjectId { get; set; }

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

Property Value
Type Description
string

RealtimeState

public DataConnector.Types.State RealtimeState { get; set; }

Output only. real-time sync state

Property Value
Type Description
DataConnectorTypesState

RealtimeSyncConfig

public DataConnector.Types.RealtimeSyncConfig RealtimeSyncConfig { get; set; }

Optional. The configuration for realtime sync.

Property Value
Type Description
DataConnectorTypesRealtimeSyncConfig

RefreshInterval

public Duration RefreshInterval { get; set; }

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.

Property Value
Type Description
Duration

RemoveParamKeys

public RepeatedField<string> RemoveParamKeys { get; }

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.

Property Value
Type Description
RepeatedFieldstring

State

public DataConnector.Types.State State { get; set; }

Output only. State of the connector.

Property Value
Type Description
DataConnectorTypesState

StaticIpAddresses

public RepeatedField<string> StaticIpAddresses { get; }

Output only. The static IP addresses used by this connector.

Property Value
Type Description
RepeatedFieldstring

StaticIpEnabled

public bool StaticIpEnabled { get; set; }

Optional. Whether customer has enabled static IP addresses for this connector.

Property Value
Type Description
bool

SyncMode

public DataConnector.Types.SyncMode SyncMode { get; set; }

The data synchronization mode supported by the data connector.

Property Value
Type Description
DataConnectorTypesSyncMode

Tag

public string Tag { get; set; }

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-<micros> 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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] was last updated.

Property Value
Type Description
Timestamp

VpcscEnabled

public bool VpcscEnabled { get; set; }

Output only. Whether the connector is created with VPC-SC enabled.

Property Value
Type Description
bool