Class GoogleCloudDiscoveryengineV1DataConnector

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.

Inheritance

object

GoogleCloudDiscoveryengineV1DataConnector

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class GoogleCloudDiscoveryengineV1DataConnector : IDirectResponseSchema

Properties

AclEnabled

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

Declaration

[JsonProperty("aclEnabled")]
public virtual bool? AclEnabled { get; set; }

Property Value

Type	Description
bool?

ActionConfig

Optional. Action configurations to make the connector support actions.

Declaration

[JsonProperty("actionConfig")]
public virtual GoogleCloudDiscoveryengineV1ActionConfig ActionConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1ActionConfig

ActionState

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

Declaration

[JsonProperty("actionState")]
public virtual string ActionState { get; set; }

Property Value

Type	Description
string

AlertPolicyConfigs

Optional. The connector level alert config.

Declaration

[JsonProperty("alertPolicyConfigs")]
public virtual IList<GoogleCloudDiscoveryengineV1AlertPolicyConfig> AlertPolicyConfigs { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1AlertPolicyConfig>

AutoRunDisabled

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

Declaration

[JsonProperty("autoRunDisabled")]
public virtual bool? AutoRunDisabled { get; set; }

Property Value

Type	Description
bool?

BapConfig

Optional. The configuration for establishing a BAP connection.

Declaration

[JsonProperty("bapConfig")]
public virtual GoogleCloudDiscoveryengineV1BAPConfig BapConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1BAPConfig

BlockingReasons

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

Declaration

[JsonProperty("blockingReasons")]
public virtual IList<string> BlockingReasons { get; set; }

Property Value

Type	Description
IList<string>

ConnectorModes

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

Declaration

[JsonProperty("connectorModes")]
public virtual IList<string> ConnectorModes { get; set; }

Property Value

Type	Description
IList<string>

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.

Declaration

[JsonProperty("connectorType")]
public virtual string ConnectorType { get; set; }

Property Value

Type	Description
string

CreateEuaSaas

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

Declaration

[JsonProperty("createEuaSaas")]
public virtual bool? CreateEuaSaas { get; set; }

Property Value

Type	Description
bool?

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp the DataConnector was created at.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DataSource

Required. The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

Declaration

[JsonProperty("dataSource")]
public virtual string DataSource { get; set; }

Property Value

Type	Description
string

DestinationConfigs

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

Declaration

[JsonProperty("destinationConfigs")]
public virtual IList<GoogleCloudDiscoveryengineV1DestinationConfig> DestinationConfigs { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1DestinationConfig>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EndUserConfig

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

Declaration

[JsonProperty("endUserConfig")]
public virtual GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig EndUserConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig

Entities

List of entities from the connected data source to ingest.

Declaration

[JsonProperty("entities")]
public virtual IList<GoogleCloudDiscoveryengineV1DataConnectorSourceEntity> Entities { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1DataConnectorSourceEntity>

Errors

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

Declaration

[JsonProperty("errors")]
public virtual IList<GoogleRpcStatus> Errors { get; set; }

Property Value

Type	Description
IList<GoogleRpcStatus>

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.

Declaration

[JsonProperty("federatedConfig")]
public virtual GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig FederatedConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig

HybridIngestionDisabled

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.

Declaration

[JsonProperty("hybridIngestionDisabled")]
public virtual bool? HybridIngestionDisabled { get; set; }

Property Value

Type	Description
bool?

IdentityRefreshInterval

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.

Declaration

[JsonProperty("identityRefreshInterval")]
public virtual object IdentityRefreshInterval { get; set; }

Property Value

Type	Description
object

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.

Declaration

[JsonProperty("identityScheduleConfig")]
public virtual GoogleCloudDiscoveryengineV1IdentityScheduleConfig IdentityScheduleConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1IdentityScheduleConfig

IncrementalRefreshInterval

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.

Declaration

[JsonProperty("incrementalRefreshInterval")]
public virtual object IncrementalRefreshInterval { get; set; }

Property Value

Type	Description
object

IncrementalSyncDisabled

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.

Declaration

[JsonProperty("incrementalSyncDisabled")]
public virtual bool? IncrementalSyncDisabled { get; set; }

Property Value

Type	Description
bool?

JsonParams

Required data connector parameters in json string format.

Declaration

[JsonProperty("jsonParams")]
public virtual string JsonParams { get; set; }

Property Value

Type	Description
string

KmsKeyName

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.

Declaration

[JsonProperty("kmsKeyName")]
public virtual string KmsKeyName { get; set; }

Property Value

Type	Description
string

LastSyncTime

object representation of LastSyncTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastSyncTimeDateTimeOffset instead.")]
public virtual object LastSyncTime { get; set; }

Property Value

Type	Description
object

LastSyncTimeDateTimeOffset

DateTimeOffset representation of LastSyncTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? LastSyncTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

LastSyncTimeRaw

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

Declaration

[JsonProperty("lastSyncTime")]
public virtual string LastSyncTimeRaw { get; set; }

Property Value

Type	Description
string

LatestPauseTime

object representation of LatestPauseTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LatestPauseTimeDateTimeOffset instead.")]
public virtual object LatestPauseTime { get; set; }

Property Value

Type	Description
object

LatestPauseTimeDateTimeOffset

DateTimeOffset representation of LatestPauseTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? LatestPauseTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

LatestPauseTimeRaw

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.

Declaration

[JsonProperty("latestPauseTime")]
public virtual string LatestPauseTimeRaw { get; set; }

Property Value

Type	Description
string

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

NextSyncTime

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.

Declaration

[JsonProperty("nextSyncTime")]
public virtual GoogleTypeDateTime NextSyncTime { get; set; }

Property Value

Type	Description
GoogleTypeDateTime

Params__

Required data connector parameters in structured json format.

Declaration

[JsonProperty("params")]
public virtual IDictionary<string, object> Params__ { get; set; }

Property Value

Type	Description
IDictionary<string, object>

PrivateConnectivityProjectId

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

Declaration

[JsonProperty("privateConnectivityProjectId")]
public virtual string PrivateConnectivityProjectId { get; set; }

Property Value

Type	Description
string

RealtimeState

Output only. real-time sync state

Declaration

[JsonProperty("realtimeState")]
public virtual string RealtimeState { get; set; }

Property Value

Type	Description
string

RealtimeSyncConfig

Optional. The configuration for realtime sync.

Declaration

[JsonProperty("realtimeSyncConfig")]
public virtual GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig RealtimeSyncConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig

RefreshInterval

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.

Declaration

[JsonProperty("refreshInterval")]
public virtual object RefreshInterval { get; set; }

Property Value

Type	Description
object

RemoveParamKeys

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.

Declaration

[JsonProperty("removeParamKeys")]
public virtual IList<string> RemoveParamKeys { get; set; }

Property Value

Type	Description
IList<string>

State

Output only. State of the connector.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

StaticIpAddresses

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

Declaration

[JsonProperty("staticIpAddresses")]
public virtual IList<string> StaticIpAddresses { get; set; }

Property Value

Type	Description
IList<string>

StaticIpEnabled

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

Declaration

[JsonProperty("staticIpEnabled")]
public virtual bool? StaticIpEnabled { get; set; }

Property Value

Type	Description
bool?

SyncMode

The data synchronization mode supported by the data connector.

Declaration

[JsonProperty("syncMode")]
public virtual string SyncMode { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp the DataConnector was last updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema