Class SourceEntity (0.20.6)

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

Attributes

Name Description
params google.protobuf.struct_pb2.Struct
The parameters for the entity to facilitate data ingestion in structured json format. This field is a member of oneof_ entity_params.
json_params str
The parameters for the entity to facilitate data ingestion in json string format. This field is a member of oneof_ entity_params.
entity_name str
The name of the entity. Supported values by data source: - Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign - Jira: Issue - Confluence: Content, Space
key_property_mappings MutableMapping[str, str]
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.
data_store str
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 method, a DataStore is automatically created for each source entity.
starting_schema google.cloud.discoveryengine_v1.types.Schema
Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from `this doc
healthcare_fhir_config google.cloud.discoveryengine_v1.types.HealthcareFhirConfig
Optional. Configuration for HEALTHCARE_FHIR vertical.

Classes

KeyPropertyMappingsEntry

KeyPropertyMappingsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.