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

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

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#acl_enabled

def acl_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.

#acl_enabled=

def acl_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
Returns
  • (::Boolean) — Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.

#action_config

def action_config() -> ::Google::Cloud::DiscoveryEngine::V1::ActionConfig
Returns

#action_config=

def action_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ActionConfig
Parameter
Returns

#action_state

def action_state() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::State
Returns

#alert_policy_configs

def alert_policy_configs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::AlertPolicyConfig>
Returns

#alert_policy_configs=

def alert_policy_configs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::AlertPolicyConfig>
Parameter
Returns

#auto_run_disabled

def auto_run_disabled() -> ::Boolean
Returns
  • (::Boolean) — 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

#auto_run_disabled=

def auto_run_disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
Returns
  • (::Boolean) — 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

#bap_config

def bap_config() -> ::Google::Cloud::DiscoveryEngine::V1::BAPConfig
Returns

#bap_config=

def bap_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::BAPConfig
Parameter
Returns

#blocking_reasons

def blocking_reasons() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::BlockingReason>
Returns

#cli_config

def cli_config() -> ::Google::Cloud::DiscoveryEngine::V1::CliConfig
Returns

#cli_config=

def cli_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::CliConfig
Parameter
Returns

#connector_modes

def connector_modes() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMode>
Returns

#connector_modes=

def connector_modes=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMode>
Parameter
Returns

#connector_source_id

def connector_source_id() -> ::String
Returns
  • (::String) — Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

#connector_source_id=

def connector_source_id=(value) -> ::String
Parameter
  • value (::String) — Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.
Returns
  • (::String) — Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

#connector_type

def connector_type() -> ::Google::Cloud::DiscoveryEngine::V1::ConnectorType
Returns

#create_eua_saas

def create_eua_saas() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.

#create_eua_saas=

def create_eua_saas=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
Returns
  • (::Boolean) — Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_protection_policy

def data_protection_policy() -> ::Google::Cloud::DiscoveryEngine::V1::DataProtectionPolicy
Returns

#data_protection_policy=

def data_protection_policy=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataProtectionPolicy
Parameter
Returns

#data_source

def data_source() -> ::String
Returns
  • (::String) — Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

#data_source=

def data_source=(value) -> ::String
Parameter
  • value (::String) — Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.
Returns
  • (::String) — Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

#destination_configs

def destination_configs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DestinationConfig>
Returns

#destination_configs=

def destination_configs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DestinationConfig>
Parameter
Returns

#dynamic_tools

def dynamic_tools() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DynamicTool>
Returns

#egress_fqdns

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

#end_user_config

def end_user_config() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::EndUserConfig
Returns

#end_user_config=

def end_user_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::EndUserConfig
Parameter
Returns

#entities

def entities() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::SourceEntity>
Returns

#entities=

def entities=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::SourceEntity>
Parameter
Returns

#errors

def errors() -> ::Array<::Google::Rpc::Status>
Returns
  • (::Array<::Google::Rpc::Status>) — Output only. The errors from initialization or from the latest connector run.

#federated_config

def federated_config() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::FederatedConfig
Returns

#federated_config=

def federated_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::FederatedConfig
Parameter
Returns

#hybrid_ingestion_disabled

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

#hybrid_ingestion_disabled=

def hybrid_ingestion_disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#identity_schedule_config

def identity_schedule_config() -> ::Google::Cloud::DiscoveryEngine::V1::IdentityScheduleConfig
Returns

#identity_schedule_config=

def identity_schedule_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityScheduleConfig
Parameter
Returns

#incremental_refresh_interval

def incremental_refresh_interval() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#incremental_refresh_interval=

def incremental_refresh_interval=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.
Returns
  • (::Google::Protobuf::Duration) — 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.

#incremental_sync_disabled

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

#incremental_sync_disabled=

def incremental_sync_disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#json_params

def json_params() -> ::String
Returns
  • (::String) — Required data connector parameters 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) — Required data connector parameters 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) — Required data connector parameters 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.

#kms_key_name

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

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#last_sync_time

def last_sync_time() -> ::Google::Protobuf::Timestamp
Returns

#latest_pause_time

def latest_pause_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) —

    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.

#metadata

def metadata() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMetadata
Returns

#metadata=

def metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMetadata
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.
Returns
  • (::String) — Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

#next_sync_time

def next_sync_time() -> ::Google::Type::DateTime
Returns
  • (::Google::Type::DateTime) — Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

#next_sync_time=

def next_sync_time=(value) -> ::Google::Type::DateTime
Parameter
  • value (::Google::Type::DateTime) — Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
Returns
  • (::Google::Type::DateTime) — Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

#oauth_static_ip_addresses

def oauth_static_ip_addresses() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

#params

def params() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Required data connector parameters 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) — Required data connector parameters 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) — Required data connector parameters 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.

#private_connectivity_project_id

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

#realtime_state

def realtime_state() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::State
Returns

#realtime_sync_config

def realtime_sync_config() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::RealtimeSyncConfig
Returns

#realtime_sync_config=

def realtime_sync_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::RealtimeSyncConfig
Parameter
Returns

#refresh_interval

def refresh_interval() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#refresh_interval=

def refresh_interval=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.
Returns
  • (::Google::Protobuf::Duration) — 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.

#remove_param_keys

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

#remove_param_keys=

def remove_param_keys=(value) -> ::Array<::String>
Parameter
  • value (::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.
Returns
  • (::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.

#state

def state() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::State
Returns

#static_ip_addresses

def static_ip_addresses() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The static IP addresses used by this connector.

#static_ip_enabled

def static_ip_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether customer has enabled static IP addresses for this connector.

#static_ip_enabled=

def static_ip_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether customer has enabled static IP addresses for this connector.
Returns
  • (::Boolean) — Optional. Whether customer has enabled static IP addresses for this connector.

#sync_mode

def sync_mode() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::SyncMode
Returns

#sync_mode=

def sync_mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::SyncMode
Parameter
Returns

#tag

def tag() -> ::String
Returns
  • (::String) — Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

    Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

    Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

#tag=

def tag=(value) -> ::String
Parameter
  • value (::String) — Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

    Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

    Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

Returns
  • (::String) — Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

    Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

    Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#vpcsc_enabled

def vpcsc_enabled() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether the connector is created with VPC-SC enabled.