Class GoogleCloudDiscoveryengineV1alphaDataConnector

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 SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. //

Inheritance

object

GoogleCloudDiscoveryengineV1alphaDataConnector

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 GoogleCloudDiscoveryengineV1alphaDataConnector : IDirectResponseSchema

Properties

ActionConfig

Optional. Action configurations to make the connector support actions.

Declaration

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

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaActionConfig

AutoRunDisabled

Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.

Declaration

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

Property Value

Type	Description
bool?

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>

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<GoogleCloudDiscoveryengineV1alphaDestinationConfig> DestinationConfigs { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaDestinationConfig>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Entities

List of entities from the connected data source to ingest.

Declaration

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

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>

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>

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 GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig IdentityScheduleConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig

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

The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.

Declaration

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

Property Value

Type	Description
GoogleTypeDateTime

Params__

Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: instance_uri * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. salesforce: * Key: client_id * Value: type STRING. The client id for the third party service provider to identify your application. * Key: client_secret * Value:type STRING. The client secret generated by the third party authorization server. * Key: access_token * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: refresh_token * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. jira, confluence: * Key: user_account * Value: type STRING. The username or email with the source. * Key: api_token * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example:

json { "instance_uri": "https://xxx.atlassian.net",
"user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }

Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: auth_type * Value: type STRING. The authorization type for the data source. Supported values: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL.

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

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.

Declaration

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

Property Value

Type	Description
object

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