Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DataConnector

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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) ⇒ GoogleCloudDiscoveryengineV1DataConnector

Returns a new instance of GoogleCloudDiscoveryengineV1DataConnector.



2532
2533
2534
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2532

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

Instance Attribute Details

#acl_enabled ⇒ Boolean Also known as: acl_enabled?

Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. Corresponds to the JSON property aclEnabled

Returns:

  • (Boolean) 


2239
2240
2241
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2239

def acl_enabled
  @acl_enabled
end

#action_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ActionConfig

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

Returns:



2245
2246
2247
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2245

def action_config
  @action_config
end

#action_state ⇒ String

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. Corresponds to the JSON property actionState

Returns:

  • (String) 


2251
2252
2253
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2251

def action_state
  @action_state
end

#alert_policy_configs ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AlertPolicyConfig>

Optional. The connector level alert config. Corresponds to the JSON property alertPolicyConfigs

Returns:



2256
2257
2258
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2256

def alert_policy_configs
  @alert_policy_configs
end

#auto_run_disabled ⇒ Boolean Also known as: auto_run_disabled?

Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs Corresponds to the JSON property autoRunDisabled

Returns:

  • (Boolean) 


2264
2265
2266
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2264

def auto_run_disabled
  @auto_run_disabled
end

#bap_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1BapConfig

The configuration for the BAP connector. Corresponds to the JSON property bapConfig

Returns:



2270
2271
2272
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2270

def bap_config
  @bap_config
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>) 


2276
2277
2278
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2276

def blocking_reasons
  @blocking_reasons
end

#cli_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1CliConfig

The configuration for the CLI execution based connectors. Corresponds to the JSON property cliConfig

Returns:



2281
2282
2283
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2281

def cli_config
  @cli_config
end

#connector_modes ⇒ Array<String>

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. Corresponds to the JSON property connectorModes

Returns:

  • (Array<String>) 


2287
2288
2289
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2287

def connector_modes
  @connector_modes
end

#connector_source_id ⇒ String

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source. Corresponds to the JSON property connectorSourceId

Returns:

  • (String) 


2293
2294
2295
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2293

def connector_source_id
  @connector_source_id
end

#connector_type ⇒ String

Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. Corresponds to the JSON property connectorType

Returns:

  • (String) 


2300
2301
2302
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2300

def connector_type
  @connector_type
end

#create_eua_saas ⇒ Boolean Also known as: create_eua_saas?

Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. Corresponds to the JSON property createEuaSaas

Returns:

  • (Boolean) 


2305
2306
2307
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2305

def create_eua_saas
  @create_eua_saas
end

#create_time ⇒ String

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

Returns:

  • (String) 


2311
2312
2313
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2311

def create_time
  @create_time
end

#data_source ⇒ String

Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the documentation for the full list of connectors. Supported first-party connectors include: * gcs * bigquery * gcp_fhir * google_mail * google_drive * google_calendar * google_chat Supported third-party connectors include: Generally available (GA) connectors: * onedrive * outlook * confluence * jira * servicenow * sharepoint Preview connectors: * asana * azure_active_directory * box * canva * confluence_server * custom_connector * docusign * dropbox * dynamics365 * github * gitlab * hubspot * jira_server * linear * native_cloud_identity * notion * okta * pagerduty * peoplesoft * salesforce * shopify * slack * snowflake * teams * trello * workday * zendesk Corresponds to the JSON property dataSource

Returns:

  • (String) 


2328
2329
2330
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2328

def data_source
  @data_source
end

#destination_configs ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DestinationConfig>

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

Returns:



2333
2334
2335
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2333

def destination_configs
  @destination_configs
end

#dynamic_tools ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DynamicTool>

Output only. The dynamic tools fetched for this connector. Corresponds to the JSON property dynamicTools

Returns:



2338
2339
2340
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2338

def dynamic_tools
  @dynamic_tools
end

#egress_fqdns ⇒ Array<String>

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Corresponds to the JSON property egressFqdns

Returns:

  • (Array<String>) 


2345
2346
2347
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2345

def egress_fqdns
  @egress_fqdns
end

#end_user_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig

Any params and credentials used specifically for EUA connectors. Corresponds to the JSON property endUserConfig

Returns:



2350
2351
2352
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2350

def end_user_config
  @end_user_config
end

#entities ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DataConnectorSourceEntity>

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

Returns:



2355
2356
2357
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2355

def entities
  @entities
end

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

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

Returns:



2360
2361
2362
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2360

def errors
  @errors
end

#federated_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig

Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. Corresponds to the JSON property federatedConfig

Returns:



2366
2367
2368
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2366

def federated_config
  @federated_config
end

#hybrid_ingestion_disabled ⇒ Boolean Also known as: hybrid_ingestion_disabled?

Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. Corresponds to the JSON property hybridIngestionDisabled

Returns:

  • (Boolean) 


2373
2374
2375
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2373

def hybrid_ingestion_disabled
  @hybrid_ingestion_disabled
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) 


2382
2383
2384
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2382

def identity_refresh_interval
  @identity_refresh_interval
end

#identity_schedule_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1IdentityScheduleConfig

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

Returns:



2387
2388
2389
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2387

def identity_schedule_config
  @identity_schedule_config
end

#incremental_refresh_interval ⇒ String

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. Corresponds to the JSON property incrementalRefreshInterval

Returns:

  • (String) 


2396
2397
2398
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2396

def incremental_refresh_interval
  @incremental_refresh_interval
end

#incremental_sync_disabled ⇒ Boolean Also known as: incremental_sync_disabled?

Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. Corresponds to the JSON property incrementalSyncDisabled

Returns:

  • (Boolean) 


2404
2405
2406
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2404

def incremental_sync_disabled
  @incremental_sync_disabled
end

#json_params ⇒ String

Required data connector parameters in json string format. Corresponds to the JSON property jsonParams

Returns:

  • (String) 


2410
2411
2412
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2410

def json_params
  @json_params
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) 


2418
2419
2420
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2418

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) 


2424
2425
2426
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2424

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) 


2434
2435
2436
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2434

def latest_pause_time
  @latest_pause_time
end

#name ⇒ String

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

Returns:

  • (String) 


2440
2441
2442
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2440

def name
  @name
end

#next_sync_time ⇒ Google::Apis::DiscoveryengineV1beta::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:



2458
2459
2460
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2458

def next_sync_time
  @next_sync_time
end

#params ⇒ Hash<String,Object>

Required data connector parameters in structured json format. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


2463
2464
2465
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2463

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) 


2470
2471
2472
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2470

def private_connectivity_project_id
  @private_connectivity_project_id
end

#realtime_state ⇒ String

Output only. real-time sync state Corresponds to the JSON property realtimeState

Returns:

  • (String) 


2475
2476
2477
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2475

def realtime_state
  @realtime_state
end

#realtime_sync_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig

The configuration for realtime sync to store additional params for realtime sync. Corresponds to the JSON property realtimeSyncConfig

Returns:



2481
2482
2483
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2481

def realtime_sync_config
  @realtime_sync_config
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. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. Corresponds to the JSON property refreshInterval

Returns:

  • (String) 


2490
2491
2492
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2490

def refresh_interval
  @refresh_interval
end

#remove_param_keys ⇒ Array<String>

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in ' remove_param_keys' and present in the 'params' field of the request. Corresponds to the JSON property removeParamKeys

Returns:

  • (Array<String>) 


2498
2499
2500
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2498

def remove_param_keys
  @remove_param_keys
end

#state ⇒ String

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

Returns:

  • (String) 


2503
2504
2505
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2503

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>) 


2508
2509
2510
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2508

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) 


2513
2514
2515
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2513

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) 


2519
2520
2521
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2519

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) 


2524
2525
2526
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2524

def update_time
  @update_time
end

#vpcsc_enabled ⇒ Boolean Also known as: vpcsc_enabled?

Output only. Whether the connector is created with VPC-SC enabled. Corresponds to the JSON property vpcscEnabled

Returns:

  • (Boolean) 


2529
2530
2531
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2529

def vpcsc_enabled
  @vpcsc_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2537

def update!(**args)
  @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
  @action_config = args[:action_config] if args.key?(:action_config)
  @action_state = args[:action_state] if args.key?(:action_state)
  @alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
  @bap_config = args[:bap_config] if args.key?(:bap_config)
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
  @cli_config = args[:cli_config] if args.key?(:cli_config)
  @connector_modes = args[:connector_modes] if args.key?(:connector_modes)
  @connector_source_id = args[:connector_source_id] if args.key?(:connector_source_id)
  @connector_type = args[:connector_type] if args.key?(:connector_type)
  @create_eua_saas = args[:create_eua_saas] if args.key?(:create_eua_saas)
  @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)
  @dynamic_tools = args[:dynamic_tools] if args.key?(:dynamic_tools)
  @egress_fqdns = args[:egress_fqdns] if args.key?(:egress_fqdns)
  @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
  @entities = args[:entities] if args.key?(:entities)
  @errors = args[:errors] if args.key?(:errors)
  @federated_config = args[:federated_config] if args.key?(:federated_config)
  @hybrid_ingestion_disabled = args[:hybrid_ingestion_disabled] if args.key?(:hybrid_ingestion_disabled)
  @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)
  @incremental_refresh_interval = args[:incremental_refresh_interval] if args.key?(:incremental_refresh_interval)
  @incremental_sync_disabled = args[:incremental_sync_disabled] if args.key?(:incremental_sync_disabled)
  @json_params = args[:json_params] if args.key?(:json_params)
  @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)
  @realtime_state = args[:realtime_state] if args.key?(:realtime_state)
  @realtime_sync_config = args[:realtime_sync_config] if args.key?(:realtime_sync_config)
  @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
  @remove_param_keys = args[:remove_param_keys] if args.key?(:remove_param_keys)
  @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)
  @vpcsc_enabled = args[:vpcsc_enabled] if args.key?(:vpcsc_enabled)
end