google-cloud-discovery_engine-v1 2.13.0 → 2.14.0

data/proto_docs/google/cloud/discoveryengine/v1/data_connector.rb

@@ -0,0 +1,875 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Manages the connection to external data sources for all data stores grouped
+        # under a {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}. It's a
+        # singleton resource of
+        # {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}. The initialization
+        # is only supported through
+        # {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#set_up_data_connector DataConnectorService.SetUpDataConnector}
+        # method, which will create a new
+        # {::Google::Cloud::DiscoveryEngine::V1::Collection Collection} and initialize its
+        # {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector}.
+        # @!attribute [rw] params
+        #   @return [::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.
+        # @!attribute [rw] json_params
+        #   @return [::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.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The full resource name of the Data Connector.
+        #     Format:
+        #     `projects/*/locations/*/collections/*/dataConnector`.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::State]
+        #     Output only. State of the connector.
+        # @!attribute [rw] data_source
+        #   @return [::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](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
+        # @!attribute [rw] remove_param_keys
+        #   @return [::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.
+        # @!attribute [rw] refresh_interval
+        #   @return [::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.
+        # @!attribute [rw] next_sync_time
+        #   @return [::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](https://www.iana.org/time-zones). 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.
+        # @!attribute [rw] entities
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::SourceEntity>]
+        #     List of entities from the connected data source to ingest.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} was created
+        #     at.
+        # @!attribute [r] latest_pause_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The most recent timestamp when this
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector 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.
+        # @!attribute [r] last_sync_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. For periodic connectors only, the last time a data sync was
+        #     completed.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} was last
+        #     updated.
+        # @!attribute [r] errors
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Output only. The errors from initialization or from the latest connector
+        #     run.
+        # @!attribute [rw] sync_mode
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::SyncMode]
+        #     The data synchronization mode supported by the data connector.
+        # @!attribute [rw] kms_key_name
+        #   @return [::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.
+        # @!attribute [rw] destination_configs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DestinationConfig>]
+        #     Optional. Any target destinations used to connect to third-party services.
+        # @!attribute [r] action_state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::State]
+        #     Output only. State of the action connector. This reflects whether the
+        #     action connector is initializing, active or has encountered errors.
+        # @!attribute [rw] action_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ActionConfig]
+        #     Optional. Action configurations to make the connector support actions.
+        # @!attribute [rw] end_user_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::EndUserConfig]
+        #     Optional. Any params and credentials used specifically for EUA connectors.
+        # @!attribute [rw] federated_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::FederatedConfig]
+        #     Optional. Any params and credentials used specifically for hybrid
+        #     connectors supporting FEDERATED mode. This field should only be set if the
+        #     connector is a hybrid connector and we want to enable FEDERATED mode.
+        # @!attribute [rw] connector_modes
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMode>]
+        #     Optional. The modes enabled for this connector. Default state is
+        #     CONNECTOR_MODE_UNSPECIFIED.
+        # @!attribute [rw] static_ip_enabled
+        #   @return [::Boolean]
+        #     Optional. Whether customer has enabled static IP addresses for this
+        #     connector.
+        # @!attribute [r] static_ip_addresses
+        #   @return [::Array<::String>]
+        #     Output only. The static IP addresses used by this connector.
+        # @!attribute [r] oauth_static_ip_addresses
+        #   @return [::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.
+        # @!attribute [r] blocking_reasons
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DataConnector::BlockingReason>]
+        #     Output only. User actions that must be completed before the connector can
+        #     start syncing data.
+        # @!attribute [rw] identity_schedule_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::IdentityScheduleConfig]
+        #     The configuration for the identity data synchronization runs. This contains
+        #     the refresh interval to sync the Access Control List information
+        #     for the documents ingested by this connector.
+        # @!attribute [r] private_connectivity_project_id
+        #   @return [::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.
+        # @!attribute [rw] bap_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::BAPConfig]
+        #     Optional. The configuration for establishing a BAP connection.
+        # @!attribute [r] connector_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ConnectorType]
+        #     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.
+        # @!attribute [r] realtime_state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::State]
+        #     Output only. real-time sync state
+        # @!attribute [rw] alert_policy_configs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AlertPolicyConfig>]
+        #     Optional. The connector level alert config.
+        # @!attribute [rw] realtime_sync_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::RealtimeSyncConfig]
+        #     Optional. The configuration for realtime sync.
+        # @!attribute [rw] acl_enabled
+        #   @return [::Boolean]
+        #     Optional. Whether the connector will be created with an ACL config.
+        #     Currently this field only affects Cloud Storage and BigQuery connectors.
+        # @!attribute [rw] create_eua_saas
+        #   @return [::Boolean]
+        #     Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+        # @!attribute [rw] auto_run_disabled
+        #   @return [::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
+        # @!attribute [rw] incremental_sync_disabled
+        #   @return [::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.
+        # @!attribute [rw] incremental_refresh_interval
+        #   @return [::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.
+        # @!attribute [rw] hybrid_ingestion_disabled
+        #   @return [::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.
+        # @!attribute [rw] data_protection_policy
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataProtectionPolicy]
+        #     Optional. Specifies the data protection policy for the connector.
+        # @!attribute [r] egress_fqdns
+        #   @return [::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.
+        # @!attribute [r] vpcsc_enabled
+        #   @return [::Boolean]
+        #     Output only. Whether the connector is created with VPC-SC enabled.
+        # @!attribute [r] dynamic_tools
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DynamicTool>]
+        #     Output only. The dynamic tools fetched for this connector.
+        # @!attribute [rw] cli_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::CliConfig]
+        #     Optional. The configuration for establishing a CLI connection.
+        # @!attribute [rw] connector_source_id
+        #   @return [::String]
+        #     Optional. If set, this value instead of `data_source` is used to fetch the
+        #     corresponding connector source.
+        # @!attribute [rw] tag
+        #   @return [::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.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMetadata]
+        #     Optional. User-facing metadata for the connector. Populated from the
+        #     connector's generated metadata / registry `ConnectorSource`.
+        class DataConnector
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents an entity in the data source. For example, the `Account` object
+          # in Salesforce.
+          # @!attribute [rw] params
+          #   @return [::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.
+          # @!attribute [rw] json_params
+          #   @return [::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.
+          # @!attribute [rw] entity_name
+          #   @return [::String]
+          #     The name of the entity. Supported values by data source:
+          #
+          #     * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`,
+          #       `Contract`, `Campaign`
+          #     * Jira: `Issue`
+          #     * Confluence: `Content`, `Space`
+          # @!attribute [rw] key_property_mappings
+          #   @return [::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.
+          # @!attribute [r] data_store
+          #   @return [::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
+          #     {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#set_up_data_connector DataConnectorService.SetUpDataConnector}
+          #     method, a {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is
+          #     automatically created for each source entity.
+          # @!attribute [rw] starting_schema
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Schema]
+          #     Optional. The start schema to use for the
+          #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} created from this
+          #     SourceEntity. If unset, a default vertical specialized schema will be
+          #     used.
+          #
+          #     This field is only used by
+          #     {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#set_up_data_connector SetUpDataConnector}
+          #     API, and will be ignored if used in other APIs. This field will be
+          #     omitted from all API responses including
+          #     {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#get_data_connector GetDataConnector}
+          #     API. To retrieve a schema of a
+          #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, use
+          #     {::Google::Cloud::DiscoveryEngine::V1::SchemaService::Client#get_schema SchemaService.GetSchema}
+          #     API instead.
+          #
+          #     The provided schema will be validated against certain rules on schema.
+          #     Learn more from [this
+          #     doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+          # @!attribute [rw] healthcare_fhir_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig]
+          #     Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+          class SourceEntity
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class KeyPropertyMappingsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Any params and credentials used specifically for EUA connectors.
+          # @!attribute [rw] auth_params
+          #   @return [::Google::Protobuf::Struct]
+          #     Optional. Any authentication parameters specific to EUA connectors.
+          #
+          #     Note: The following fields are mutually exclusive: `auth_params`, `json_auth_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] json_auth_params
+          #   @return [::String]
+          #     Optional. Any authentication parameters specific to EUA connectors in
+          #     json string format.
+          #
+          #     Note: The following fields are mutually exclusive: `json_auth_params`, `auth_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] additional_params
+          #   @return [::Google::Protobuf::Struct]
+          #     Optional. Any additional parameters needed for EUA.
+          # @!attribute [rw] tenant
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Tenant]
+          #     Optional. The tenant project the connector is connected to.
+          class EndUserConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Any params and credentials used specifically for hybrid connectors
+          # supporting FEDERATED mode.
+          # @!attribute [rw] auth_params
+          #   @return [::Google::Protobuf::Struct]
+          #     Optional. Any authentication parameters specific to FEDERATED
+          #     connectors.
+          #
+          #     Note: The following fields are mutually exclusive: `auth_params`, `json_auth_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] json_auth_params
+          #   @return [::String]
+          #     Optional. Any authentication parameters specific to FEDERATED
+          #     connectors in json string format.
+          #
+          #     Note: The following fields are mutually exclusive: `json_auth_params`, `auth_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] additional_params
+          #   @return [::Google::Protobuf::Struct]
+          #     Optional. Any additional parameters needed for FEDERATED.
+          class FederatedConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The configuration for realtime sync to store additional params for
+          # realtime sync.
+          # @!attribute [rw] webhook_uri
+          #   @return [::String]
+          #     Optional. Webhook url for the connector to specify additional params for
+          #     realtime sync.
+          # @!attribute [rw] realtime_sync_secret
+          #   @return [::String]
+          #     Optional. The ID of the Secret Manager secret used for webhook secret.
+          # @!attribute [rw] streaming_error
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::RealtimeSyncConfig::StreamingError]
+          #     Optional. Streaming error details.
+          class RealtimeSyncConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Streaming error details.
+            # @!attribute [rw] streaming_error_reason
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::RealtimeSyncConfig::StreamingError::StreamingErrorReason]
+            #     Optional. Streaming error.
+            # @!attribute [rw] error
+            #   @return [::Google::Rpc::Status]
+            #     Optional. Error details.
+            class StreamingError
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Broad types of streaming errors.
+              module StreamingErrorReason
+                # Streaming error reason unspecified.
+                STREAMING_ERROR_REASON_UNSPECIFIED = 0
+
+                # Some error occurred while setting up resources for realtime sync.
+                STREAMING_SETUP_ERROR = 1
+
+                # Some error was encountered while running realtime sync for the
+                # connector.
+                STREAMING_SYNC_ERROR = 2
+
+                # Ingress endpoint is required when setting up realtime sync in private
+                # connectivity.
+                INGRESS_ENDPOINT_REQUIRED = 3
+              end
+            end
+          end
+
+          # User-facing metadata for the connector, shown on the connector detail
+          # page (title, description, short_description, author, note).
+          # @!attribute [rw] title
+          #   @return [::String]
+          #     Optional. Display title of the connector.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     Optional. Human-readable description of the connector, shown on the
+          #     connector detail page. One connector has a single description.
+          # @!attribute [rw] short_description
+          #   @return [::String]
+          #     Optional. Short, subtitle-length description of the connector (e.g. shown
+          #     beneath the connector name in list and detail views).
+          # @!attribute [rw] author
+          #   @return [::String]
+          #     Optional. The party that authored the connector, e.g. "Google" or a
+          #     third-party provider name. Lets end users see who authored a connector.
+          # @!attribute [rw] note
+          #   @return [::String]
+          #     Optional. Free-form, multi-line note about the connector's capabilities
+          #     or a custom note that can be set for the connector.
+          class ConnectorMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The state of connector.
+          module State
+            # Default value.
+            STATE_UNSPECIFIED = 0
+
+            # The connector is being set up.
+            CREATING = 1
+
+            # The connector is successfully set up and awaiting next sync run.
+            ACTIVE = 2
+
+            # The connector is in error. The error details can be found in
+            # {::Google::Cloud::DiscoveryEngine::V1::DataConnector#errors DataConnector.errors}.
+            # If the error is unfixable, the
+            # {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} can be
+            # deleted by
+            # {::Google::Cloud::DiscoveryEngine::V1::CollectionService::Client#delete_collection CollectionService.DeleteCollection}
+            # API.
+            FAILED = 3
+
+            # The connector is actively syncing records from the data source.
+            RUNNING = 4
+
+            # The connector has completed a sync run, but encountered non-fatal errors.
+            WARNING = 5
+
+            # Connector initialization failed. Potential causes include runtime errors
+            # or issues in the asynchronous pipeline, preventing the request from
+            # reaching downstream services (except for some connector types).
+            INITIALIZATION_FAILED = 6
+
+            # Connector is in the process of an update.
+            UPDATING = 7
+          end
+
+          # Defines the data synchronization mode supported by the data connector.
+          module SyncMode
+            # The connector will sync data periodically based on the refresh_interval.
+            # Use it with auto_run_disabled to pause the periodic sync, or indicate a
+            # one-time sync.
+            PERIODIC = 0
+
+            # The data will be synced in real time.
+            STREAMING = 1
+
+            # Connector that doesn't ingest data will have this value
+            UNSPECIFIED = 2
+          end
+
+          # The modes enabled for this connector. INGESTION, ACTIONS, FEDERATED, OR EUA
+          module ConnectorMode
+            # Connector mode unspecified.
+            CONNECTOR_MODE_UNSPECIFIED = 0
+
+            # Connector utilized for data ingestion.
+            DATA_INGESTION = 1
+
+            # Connector utilized for actions.
+            ACTIONS = 2
+
+            # Connector utilized for federated search.
+            FEDERATED = 3
+
+            # Connector utilized for End User Authentication.
+            EUA = 4
+
+            # Hybrid connector utilized for federated search and End User
+            # Authentication.
+            FEDERATED_AND_EUA = 5
+          end
+
+          # User actions that must be completed before the connector can
+          # start syncing data.
+          module BlockingReason
+            # Default value.
+            BLOCKING_REASON_UNSPECIFIED = 0
+
+            # Connector requires customer to allowlist static IPs.
+            ALLOWLIST_STATIC_IP = 1
+
+            # Connector requires customer to allowlist our project in their service
+            # attachment.
+            ALLOWLIST_IN_SERVICE_ATTACHMENT = 2
+
+            # Connector requires customer to allowlist service account in their
+            # project.
+            ALLOWLIST_SERVICE_ACCOUNT = 3
+          end
+        end
+
+        # Defines target endpoints used to connect to third-party sources.
+        # @!attribute [rw] params
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. Additional parameters for this destination config 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.
+        # @!attribute [rw] json_params
+        #   @return [::String]
+        #     Additional parameters for this destination config 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.
+        # @!attribute [rw] key
+        #   @return [::String]
+        #     Optional. Unique destination identifier that is supported by the connector.
+        # @!attribute [rw] destinations
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DestinationConfig::Destination>]
+        #     Optional. The destinations for the corresponding key.
+        class DestinationConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Defines a target endpoint
+          # @!attribute [rw] host
+          #   @return [::String]
+          #     Publicly routable host.
+          # @!attribute [rw] port
+          #   @return [::Integer]
+          #     Optional. Target port number accepted by the destination.
+          class Destination
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Informations to support actions on the connector.
+        # @!attribute [rw] action_params
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. Action parameters in structured json format.
+        #
+        #     Note: The following fields are mutually exclusive: `action_params`, `json_action_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] json_action_params
+        #   @return [::String]
+        #     Optional. Action parameters in json string format.
+        #
+        #     Note: The following fields are mutually exclusive: `json_action_params`, `action_params`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] is_action_configured
+        #   @return [::Boolean]
+        #     Output only. The connector contains the necessary parameters and is
+        #     configured to support actions.
+        # @!attribute [rw] service_name
+        #   @return [::String]
+        #     Optional. The Service Directory resource name
+        #     (projects/*/locations/*/namespaces/*/services/*)
+        #     representing a VPC network endpoint used to connect to the data source's
+        #     `instance_uri`, defined in
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector#params DataConnector.params}.
+        #
+        #     Required when VPC Service Controls are enabled.
+        # @!attribute [rw] use_static_secrets
+        #   @return [::Boolean]
+        #     Optional. Whether to use static secrets for the connector. If true, the
+        #     secrets provided in the action_params will be ignored.
+        # @!attribute [rw] create_bap_connection
+        #   @return [::Boolean]
+        #     Optional. Whether to create a BAP connection for the connector.
+        # @!attribute [rw] user_defined_scopes_mapping
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList}]
+        #     Optional. Mapping from operation name to the list of scopes. Only be
+        #     populated if there are user specified scopes.
+        class ActionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Stores a list of scopes.
+          # @!attribute [rw] scopes
+          #   @return [::Array<::String>]
+          #     Optional. The list of scopes.
+          class ScopeList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList]
+          class UserDefinedScopesMappingEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The configuration for the identity data synchronization runs.
+        # @!attribute [rw] refresh_interval
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. 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.
+        # @!attribute [rw] next_sync_time
+        #   @return [::Google::Type::DateTime]
+        #     Optional. The UTC time when the next data sync is expected to start for the
+        #     Data Connector. Customers are only able to specify the hour and minute to
+        #     schedule the data sync. This is utilized when the data connector has a
+        #     refresh interval greater than 1 day.
+        class IdentityScheduleConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The configuration for the BAP connector.
+        # @!attribute [rw] supported_connector_modes
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::BAPConfig::ConnectorMode>]
+        #     Required. The supported connector modes for the associated BAP connection.
+        # @!attribute [rw] enabled_actions
+        #   @return [::Array<::String>]
+        #     Optional. The actions enabled on the associated BAP connection.
+        # @!attribute [rw] toolspec_override
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::BAPConfig::ToolspecOverride]
+        #     Optional. Custom toolspec overrides for this connection. For Enterprise BAP
+        #     connectors that support admin-curated tool definitions, this holds the
+        #     (simplified) per-tool overrides. On Get, populated by the server by
+        #     merging persisted overrides with live runtime tool definitions and
+        #     trimming the result for UI consumption. On Update, the supplied value
+        #     replaces the persisted overrides after server-side validation and
+        #     merging: the `base_version` field MUST match the server's current base
+        #     toolspec version (otherwise the request is rejected with a user-facing
+        #     error directing the admin to re-download the latest tools first).
+        class BAPConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Customer-facing view of the admin-curated toolspec for a BAP
+          # connection. Holds the (simplified) per-tool definitions surfaced to
+          # and editable by the admin in the Discovery Engine UI.
+          #
+          # Mirrors the shape of the backend
+          # `google.cloud.connectorexecution.v1.ToolspecOverride` message, but
+          # is intentionally kept as a separate public type so the Discovery
+          # Engine API surface can evolve independently of the fed-API surface
+          # (AIP-215). Handlers convert between the two via helpers in
+          # //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.
+          # @!attribute [rw] tools
+          #   @return [::Array<::Google::Protobuf::Struct>]
+          #     Required. Tool definitions (one Struct per tool) that the admin has
+          #     customised on top of the base toolspec returned by the fed API.
+          #     REQUIRED because it is the only user-editable field in the
+          #     modify API; the request must carry at least one tool.
+          # @!attribute [rw] base_version
+          #   @return [::String]
+          #     Required. Base toolspec version against which `tools` were authored. On
+          #     Update, MUST match the server's current stable toolspec version
+          #     for the connection; mismatch is rejected with a user-facing error
+          #     directing the admin to re-download the latest tools first.
+          class ToolspecOverride
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Use cases supported by this BAP connector.
+          module ConnectorMode
+            # Connector mode unspecified.
+            CONNECTOR_MODE_UNSPECIFIED = 0
+
+            # Connector utilized for data ingestion.
+            DATA_INGESTION = 1
+
+            # Connector utilized for Actions
+            ACTIONS = 2
+
+            # Connector utilized for End User Authentication.
+            END_USER_AUTHENTICATION = 3
+          end
+        end
+
+        # The configuration for the CLI execution based connectors.
+        # @!attribute [rw] enabled_actions
+        #   @return [::Array<::String>]
+        #     Optional. The actions enabled on the associated CLI connection.
+        class CliConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The connector level alert config.
+        # @!attribute [rw] alert_policy_name
+        #   @return [::String]
+        #     Immutable. The fully qualified resource name of the AlertPolicy.
+        # @!attribute [rw] alert_enrollments
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AlertPolicyConfig::AlertEnrollment>]
+        #     Optional. The enrollment states of each alert.
+        class AlertPolicyConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The alert enrollment status.
+          # @!attribute [rw] alert_id
+          #   @return [::String]
+          #     Immutable. The id of an alert.
+          # @!attribute [rw] enroll_state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::AlertPolicyConfig::AlertEnrollment::EnrollStates]
+          #     Required. The enrollment status of a customer.
+          class AlertEnrollment
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The enrollment status enum for the alert.
+            module EnrollStates
+              # Default value. Used for customers who have not responded to the
+              # alert policy.
+              ENROLL_STATES_UNSPECIFIED = 0
+
+              # Customer is enrolled in this policy.
+              ENROLLED = 1
+
+              # Customer declined this policy.
+              DECLINED = 2
+            end
+          end
+        end
+
+        # Tenant information for a connector source. This includes some of the same
+        # information stored in the Credential message, but is limited to only what is
+        # needed to provide a list of accessible tenants to the user.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     The tenant's instance ID. Examples: Jira
+        #     ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The URI of the tenant, if applicable. For example, the URI of a Jira
+        #     instance is https://my-jira-instance.atlassian.net, and a Slack tenant does
+        #     not have a URI.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional display name for the tenant, e.g. "My Slack Team".
+        class Tenant
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for dynamic tools.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the tool.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The description of the tool.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Optional. Whether the tool is enabled.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. The display name of the tool.
+        class DynamicTool
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The type of connector.
+        # New values may be added to this enum in the future.
+        module ConnectorType
+          # Default value.
+          CONNECTOR_TYPE_UNSPECIFIED = 0
+
+          # Third party connector to connector to third party application.
+          THIRD_PARTY = 1
+
+          # Data connector connects between FHIR store and VAIS datastore.
+          GCP_FHIR = 2
+
+          # Big query connector.
+          BIG_QUERY = 3
+
+          # Google Cloud Storage connector.
+          GCS = 4
+
+          # Gmail connector.
+          GOOGLE_MAIL = 5
+
+          # Google Calendar connector.
+          GOOGLE_CALENDAR = 6
+
+          # Google Drive connector.
+          GOOGLE_DRIVE = 7
+
+          # Native Cloud Identity connector for people search powered by People API.
+          NATIVE_CLOUD_IDENTITY = 8
+
+          # Federated connector, it is a third party connector that doesn't ingestion
+          # data, and search is powered by third party application's API.
+          THIRD_PARTY_FEDERATED = 9
+
+          # Connector utilized for End User Authentication features.
+          THIRD_PARTY_EUA = 10
+
+          # Google Cloud NetApp Volumes connector.
+          GCNV = 11
+
+          # Google Chat connector.
+          GOOGLE_CHAT = 12
+
+          # Google Sites connector.
+          GOOGLE_SITES = 13
+
+          # Remote MCP based connector.
+          REMOTE_MCP = 14
+
+          # Google Workspace connector.
+          GOOGLE_WORKSPACE = 15
+        end
+      end
+    end
+  end
+end