Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::DataConnector::SourceEntity (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::DataConnector::SourceEntity.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#data_store

def data_store() -> ::String
Returns
  • (::String) — 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.

#entity_name

def entity_name() -> ::String
Returns
  • (::String) —

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

    • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
    • Jira: Issue
    • Confluence: Content, Space

#entity_name=

def entity_name=(value) -> ::String
Parameter
  • value (::String) —

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

    • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
    • Jira: Issue
    • Confluence: Content, Space
Returns
  • (::String) —

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

    • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
    • Jira: Issue
    • Confluence: Content, Space

#healthcare_fhir_config

def healthcare_fhir_config() -> ::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig
Returns

#healthcare_fhir_config=

def healthcare_fhir_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig
Parameter
Returns

#json_params

def json_params() -> ::String
Returns
  • (::String) — The parameters for the entity to facilitate data ingestion in json string format.

    Note: The following fields are mutually exclusive: json_params, params. If a field in that set is populated, all other fields in the set will automatically be cleared.

#json_params=

def json_params=(value) -> ::String
Parameter
  • value (::String) — The parameters for the entity to facilitate data ingestion in json string format.

    Note: The following fields are mutually exclusive: json_params, params. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The parameters for the entity to facilitate data ingestion in json string format.

    Note: The following fields are mutually exclusive: json_params, params. If a field in that set is populated, all other fields in the set will automatically be cleared.

#key_property_mappings

def key_property_mappings() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    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.

#key_property_mappings=

def key_property_mappings=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) —

    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
  • (::Google::Protobuf::Map{::String => ::String}) —

    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.

#params

def params() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — The parameters for the entity to facilitate data ingestion in structured json format.

    Note: The following fields are mutually exclusive: params, json_params. If a field in that set is populated, all other fields in the set will automatically be cleared.

#params=

def params=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — The parameters for the entity to facilitate data ingestion in structured json format.

    Note: The following fields are mutually exclusive: params, json_params. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Struct) — The parameters for the entity to facilitate data ingestion in structured json format.

    Note: The following fields are mutually exclusive: params, json_params. If a field in that set is populated, all other fields in the set will automatically be cleared.

#starting_schema

def starting_schema() -> ::Google::Cloud::DiscoveryEngine::V1::Schema
Returns

#starting_schema=

def starting_schema=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Schema
Parameter
Returns