Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity

Returns a new instance of GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.



8134
8135
8136
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8134

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data_store ⇒ 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. Corresponds to the JSON property dataStore

Returns:

  • (String) 


8109
8110
8111
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8109

def data_store
  @data_store
end

#entity_name ⇒ String

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

Returns:

  • (String) 


8116
8117
8118
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8116

def entity_name
  @entity_name
end

#key_property_mappings ⇒ Hash<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. Corresponds to the JSON property keyPropertyMappings

Returns:

  • (Hash<String,String>) 


8125
8126
8127
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8125

def key_property_mappings
  @key_property_mappings
end

#params ⇒ Hash<String,Object>

The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: document_id_column * Value: type STRING. The value of the column id. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


8132
8133
8134
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8132

def params
  @params
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8139
8140
8141
8142
8143
8144
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8139

def update!(**args)
  @data_store = args[:data_store] if args.key?(:data_store)
  @entity_name = args[:entity_name] if args.key?(:entity_name)
  @key_property_mappings = args[:key_property_mappings] if args.key?(:key_property_mappings)
  @params = args[:params] if args.key?(:params)
end