Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SourceEntity.
Represents an entity in the data source. For example, the Account object
in Salesforce.
Generated from protobuf message google.cloud.discoveryengine.v1.DataConnector.SourceEntity
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ DataConnectorMethods
__construct
Constructor.
| Parameter | |
|---|---|
| Name | Description |
data |
mixed
|
getParams
The parameters for the entity to facilitate data ingestion in structured json format.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasParams
setParams
The parameters for the entity to facilitate data ingestion in structured json format.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJsonParams
The parameters for the entity to facilitate data ingestion in json string format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasJsonParams
setJsonParams
The parameters for the entity to facilitate data ingestion in json string format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityName
The name of the entity. Supported values by data source:
- Salesforce:
Lead,Opportunity,Contact,Account,Case,Contract,Campaign - Jira:
Issue - Confluence:
Content,Space
| Returns | |
|---|---|
| Type | Description |
string |
|
setEntityName
The name of the entity. Supported values by data source:
- Salesforce:
Lead,Opportunity,Contact,Account,Case,Contract,Campaign - Jira:
Issue - Confluence:
Content,Space
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyPropertyMappings
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setKeyPropertyMappings
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataStore
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataStore
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartingSchema
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\Schema|null |
|
hasStartingSchema
clearStartingSchema
setStartingSchema
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\Schema
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHealthcareFhirConfig
Optional. Configuration for HEALTHCARE_FHIR vertical.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\HealthcareFhirConfig|null |
|
hasHealthcareFhirConfig
clearHealthcareFhirConfig
setHealthcareFhirConfig
Optional. Configuration for HEALTHCARE_FHIR vertical.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\HealthcareFhirConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityParams
| Returns | |
|---|---|
| Type | Description |
string |
|