Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector

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

Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService. SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDataConnector

Returns a new instance of GoogleCloudDiscoveryengineV1alphaDataConnector.



8065
8066
8067
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8065

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

Instance Attribute Details

#action_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaActionConfig

Informations to support actions on the connector. Corresponds to the JSON property actionConfig

Returns:



7898
7899
7900
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7898

def action_config
  @action_config
end

#auto_run_disabled ⇒ Boolean Also known as: auto_run_disabled?

Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Corresponds to the JSON property autoRunDisabled

Returns:

  • (Boolean) 


7904
7905
7906
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7904

def auto_run_disabled
  @auto_run_disabled
end

#blocking_reasons ⇒ Array<String>

Output only. User actions that must be completed before the connector can start syncing data. Corresponds to the JSON property blockingReasons

Returns:

  • (Array<String>) 


7911
7912
7913
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7911

def blocking_reasons
  @blocking_reasons
end

#create_time ⇒ String

Output only. Timestamp the DataConnector was created at. Corresponds to the JSON property createTime

Returns:

  • (String) 


7916
7917
7918
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7916

def create_time
  @create_time
end

#data_source ⇒ String

Required. The name of the data source. Supported values: salesforce, jira, confluence, bigquery. Corresponds to the JSON property dataSource

Returns:

  • (String) 


7922
7923
7924
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7922

def data_source
  @data_source
end

#destination_configs ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDestinationConfig>

Optional. Any target destinations used to connect to third-party services. Corresponds to the JSON property destinationConfigs

Returns:



7927
7928
7929
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7927

def destination_configs
  @destination_configs
end

#entities ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>

List of entities from the connected data source to ingest. Corresponds to the JSON property entities

Returns:



7932
7933
7934
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7932

def entities
  @entities
end

#errors ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>

Output only. The errors from initialization or from the latest connector run. Corresponds to the JSON property errors

Returns:



7937
7938
7939
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7937

def errors
  @errors
end

#identity_refresh_interval ⇒ String

The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. Corresponds to the JSON property identityRefreshInterval

Returns:

  • (String) 


7945
7946
7947
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7945

def identity_refresh_interval
  @identity_refresh_interval
end

#identity_schedule_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig

The configuration for the identity data synchronization runs. Corresponds to the JSON property identityScheduleConfig

Returns:



7950
7951
7952
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7950

def identity_schedule_config
  @identity_schedule_config
end

#kms_key_name ⇒ String

Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


7958
7959
7960
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7958

def kms_key_name
  @kms_key_name
end

#last_sync_time ⇒ String

Output only. For periodic connectors only, the last time a data sync was completed. Corresponds to the JSON property lastSyncTime

Returns:

  • (String) 


7964
7965
7966
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7964

def last_sync_time
  @last_sync_time
end

#latest_pause_time ⇒ String

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. Corresponds to the JSON property latestPauseTime

Returns:

  • (String) 


7974
7975
7976
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7974

def latest_pause_time
  @latest_pause_time
end

#name ⇒ String

Output only. The full resource name of the Data Connector. Format: projects/*/ locations/*/collections/*/dataConnector. Corresponds to the JSON property name

Returns:

  • (String) 


7980
7981
7982
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7980

def name
  @name
end

#next_sync_time ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleTypeDateTime

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. Corresponds to the JSON property nextSyncTime

Returns:



7998
7999
8000
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7998

def next_sync_time
  @next_sync_time
end

#params ⇒ Hash<String,Object>

Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: instance_uri * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. salesforce: * Key: client_id * Value: type STRING. The client id for the third party service provider to identify your application. * Key: client_secret * Value:type STRING. The client secret generated by the third party authorization server. * Key: access_token

  • Value: type STRING. OAuth token for UCS to access to the protected resource.
  • Key: refresh_token * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. jira, confluence: * Key: user_account * Value: type STRING. The username or email with the source. * Key: api_token * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: json ` "instance_uri": "https://xxx.atlassian.net", " user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" ` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: auth_type * Value: type STRING. The authorization type for the data source. Supported values: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


8023
8024
8025
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8023

def params
  @params
end

#private_connectivity_project_id ⇒ String

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. Corresponds to the JSON property privateConnectivityProjectId

Returns:

  • (String) 


8030
8031
8032
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8030

def private_connectivity_project_id
  @private_connectivity_project_id
end

#refresh_interval ⇒ String

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. Corresponds to the JSON property refreshInterval

Returns:

  • (String) 


8037
8038
8039
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8037

def refresh_interval
  @refresh_interval
end

#state ⇒ String

Output only. State of the connector. Corresponds to the JSON property state

Returns:

  • (String) 


8042
8043
8044
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8042

def state
  @state
end

#static_ip_addresses ⇒ Array<String>

Output only. The static IP addresses used by this connector. Corresponds to the JSON property staticIpAddresses

Returns:

  • (Array<String>) 


8047
8048
8049
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8047

def static_ip_addresses
  @static_ip_addresses
end

#static_ip_enabled ⇒ Boolean Also known as: static_ip_enabled?

Optional. Whether customer has enabled static IP addresses for this connector. Corresponds to the JSON property staticIpEnabled

Returns:

  • (Boolean) 


8052
8053
8054
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8052

def static_ip_enabled
  @static_ip_enabled
end

#sync_mode ⇒ String

The data synchronization mode supported by the data connector. Corresponds to the JSON property syncMode

Returns:

  • (String) 


8058
8059
8060
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8058

def sync_mode
  @sync_mode
end

#update_time ⇒ String

Output only. Timestamp the DataConnector was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


8063
8064
8065
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8063

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8070

def update!(**args)
  @action_config = args[:action_config] if args.key?(:action_config)
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_source = args[:data_source] if args.key?(:data_source)
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
  @entities = args[:entities] if args.key?(:entities)
  @errors = args[:errors] if args.key?(:errors)
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
  @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time)
  @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
  @name = args[:name] if args.key?(:name)
  @next_sync_time = args[:next_sync_time] if args.key?(:next_sync_time)
  @params = args[:params] if args.key?(:params)
  @private_connectivity_project_id = args[:private_connectivity_project_id] if args.key?(:private_connectivity_project_id)
  @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
  @state = args[:state] if args.key?(:state)
  @static_ip_addresses = args[:static_ip_addresses] if args.key?(:static_ip_addresses)
  @static_ip_enabled = args[:static_ip_enabled] if args.key?(:static_ip_enabled)
  @sync_mode = args[:sync_mode] if args.key?(:sync_mode)
  @update_time = args[:update_time] if args.key?(:update_time)
end