Discovery Engine v1 API - Class DataConnector.Types.SourceEntity (1.17.0) 

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

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

Represents an entity in the data source. For example, the Account object in Salesforce.

Inheritance

object > DataConnector.Types.SourceEntity

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SourceEntity()

public SourceEntity()

SourceEntity(SourceEntity)

public SourceEntity(DataConnector.Types.SourceEntity other)
Parameter
Name Description
other DataConnectorTypesSourceEntity

Properties

DataStore

public string DataStore { get; set; }

Output only. The full resource name of the associated data store for the source entity. Format: projects/*/locations/*/collections/*/dataStores/*. When the connector is initialized by the [DataConnectorService.SetUpDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.SetUpDataConnector] method, a [DataStore][google.cloud.discoveryengine.v1.DataStore] is automatically created for each source entity.

Property Value
Type Description
string

DataStoreAsDataStoreName

public DataStoreName DataStoreAsDataStoreName { get; set; }

DataStoreName-typed view over the DataStore resource name property.

Property Value
Type Description
DataStoreName

EntityName

public string EntityName { get; set; }

The name of the entity. Supported values by data source:

  • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
  • Jira: Issue
  • Confluence: Content, Space
Property Value
Type Description
string

EntityParamsCase

public DataConnector.Types.SourceEntity.EntityParamsOneofCase EntityParamsCase { get; }
Property Value
Type Description
DataConnectorTypesSourceEntityEntityParamsOneofCase

HasJsonParams

public bool HasJsonParams { get; }

Gets whether the "json_params" field is set

Property Value
Type Description
bool

HealthcareFhirConfig

public HealthcareFhirConfig HealthcareFhirConfig { get; set; }

Optional. Configuration for HEALTHCARE_FHIR vertical.

Property Value
Type Description
HealthcareFhirConfig

JsonParams

public string JsonParams { get; set; }

The parameters for the entity to facilitate data ingestion in json string format.

Property Value
Type Description
string

KeyPropertyMappings

public MapField<string, string> KeyPropertyMappings { get; }

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

  • title: The title for data record. This would be displayed on search results.
  • description: The description for data record. This would be displayed on search results.
Property Value
Type Description
MapFieldstringstring

Params

public Struct Params { get; set; }

The parameters for the entity to facilitate data ingestion in structured json format.

Property Value
Type Description
Struct

StartingSchema

public Schema StartingSchema { get; set; }

Optional. The start schema to use for the [DataStore][google.cloud.discoveryengine.v1.DataStore] created from this SourceEntity. If unset, a default vertical specialized schema will be used.

This field is only used by [SetUpDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.SetUpDataConnector] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [GetDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.GetDataConnector] API. To retrieve a schema of a [DataStore][google.cloud.discoveryengine.v1.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] API instead.

The provided schema will be validated against certain rules on schema. Learn more from this doc.

Property Value
Type Description
Schema