com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	clone()
String	getDataStore() Output only.
String	getEntityName() The name of the entity.
GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig	getHealthcareFhirConfig() Optional.
String	getJsonParams() The parameters for the entity to facilitate data ingestion in json string format.
Map<String,String>	getKeyPropertyMappings() Attributes for indexing.
Map<String,Object>	getParams() The parameters for the entity to facilitate data ingestion in structured json format.
GoogleCloudDiscoveryengineV1alphaSchema	getStartingSchema() Optional.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setDataStore(String dataStore) Output only.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setEntityName(String entityName) The name of the entity.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setHealthcareFhirConfig(GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig healthcareFhirConfig) Optional.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setJsonParams(String jsonParams) The parameters for the entity to facilitate data ingestion in json string format.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setKeyPropertyMappings(Map<String,String> keyPropertyMappings) Attributes for indexing.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setParams(Map<String,Object> params) The parameters for the entity to facilitate data ingestion in structured json format.
GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity	setStartingSchema(GoogleCloudDiscoveryengineV1alphaSchema startingSchema) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity()

Method Detail

getDataStore

public String 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:

value or null for none

setDataStore

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setDataStore(String dataStore)

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.

Parameters:

dataStore - dataStore or null for none

getEntityName

public String 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:

value or null for none

setEntityName

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setEntityName(String entityName)

The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`

Parameters:

entityName - entityName or null for none

getHealthcareFhirConfig

public GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig getHealthcareFhirConfig()

Optional. Configuration for `HEALTHCARE_FHIR` vertical.

Returns:

value or null for none

setHealthcareFhirConfig

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setHealthcareFhirConfig(GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig healthcareFhirConfig)

Optional. Configuration for `HEALTHCARE_FHIR` vertical.

Parameters:

healthcareFhirConfig - healthcareFhirConfig or null for none

getJsonParams

public String getJsonParams()

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

Returns:

value or null for none

setJsonParams

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setJsonParams(String jsonParams)

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

Parameters:

jsonParams - jsonParams or null for none

getKeyPropertyMappings

public Map<String,String> 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:

value or null for none

setKeyPropertyMappings

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setKeyPropertyMappings(Map<String,String> keyPropertyMappings)

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.

Parameters:

keyPropertyMappings - keyPropertyMappings or null for none

getParams

public Map<String,Object> getParams()

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

Returns:

value or null for none

setParams

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setParams(Map<String,Object> params)

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

Parameters:

params - params or null for none

getStartingSchema

public GoogleCloudDiscoveryengineV1alphaSchema 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](https://cloud.google.com/generative-ai-app- builder/docs/provide-schema).

Returns:

value or null for none

setStartingSchema

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity setStartingSchema(GoogleCloudDiscoveryengineV1alphaSchema startingSchema)

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](https://cloud.google.com/generative-ai-app- builder/docs/provide-schema).

Parameters:

startingSchema - startingSchema or null for none

set

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity set(String fieldName,
                                                                      Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity clone()

Overrides:

clone in class com.google.api.client.json.GenericJson