google-cloud-discovery_engine-v1 2.13.0 → 2.14.0

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

@@ -0,0 +1,142 @@
+# 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
+        # Request for
+        # {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#set_up_data_connector DataConnectorService.SetUpDataConnector}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}, in the format of
+        #     `projects/{project}/locations/{location}`.
+        # @!attribute [rw] collection_id
+        #   @return [::String]
+        #     Required. The ID to use for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}, which will become
+        #     the final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}'s resource name. A
+        #     new {::Google::Cloud::DiscoveryEngine::V1::Collection Collection} is created as
+        #     part of the {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector}
+        #     setup. {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} is a
+        #     singleton resource under
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}, managing all
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}.
+        #
+        #     Should conform to
+        #     [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
+        #     limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] collection_display_name
+        #   @return [::String]
+        #     Required. The display name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}.
+        #
+        #     Should be human readable, used to display collections in the Console
+        #     Dashboard. UTF-8 encoded string with limit of 1024 characters.
+        # @!attribute [rw] data_connector
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector]
+        #     Required. The
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} to
+        #     initialize in the newly created
+        #     {::Google::Cloud::DiscoveryEngine::V1::Collection Collection}.
+        class SetUpDataConnectorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for
+        # {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#set_up_data_connector DataConnectorService.SetUpDataConnector}
+        # method.
+        class SetUpDataConnectorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for
+        # {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#get_data_connector DataConnectorService.GetDataConnector}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector}, regardless
+        #     of whether or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the requested
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} does not
+        #     exist, a `NOT_FOUND` error is returned.
+        class GetDataConnectorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DataConnectorService::Client#update_data_connector DataConnectorService.UpdateDataConnector}
+        # method.
+        # @!attribute [rw] data_connector
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector]
+        #     Required. The
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} to update.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector}, regardless
+        #     of whether or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} does
+        #     not exist, a `NOT_FOUND` error is returned.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataConnector DataConnector} to update.
+        #
+        #     Supported field paths include:
+        #
+        #      - `refresh_interval`
+        #      - `params`
+        #      - `auto_run_disabled`
+        #      - `action_config`
+        #      - `action_config.action_params`
+        #      - `action_config.service_name`
+        #      - `destination_configs`
+        #      - `blocking_reasons`
+        #      - `sync_mode`
+        #      - `incremental_sync_disabled`
+        #      - `incremental_refresh_interval`
+        #      - `data_protection_policy`
+        #
+        #     Note:  Support for these fields may vary depending on the connector type.
+        #            For example, not all connectors support `destination_configs`.
+        #
+        #     If an unsupported or unknown field path is provided, the request will
+        #     return an `INVALID_ARGUMENT` error.
+        class UpdateDataConnectorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -134,6 +134,9 @@ module Google
         # @!attribute [rw] healthcare_fhir_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig]
         #     Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+        # @!attribute [rw] serving_config_data_store
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::ServingConfigDataStore]
+        #     Optional. Stores serving config at DataStore level.
         # @!attribute [rw] identity_mapping_store
         #   @return [::String]
         #     Immutable. The fully qualified resource name of the associated
@@ -141,6 +144,22 @@ module Google
         #     This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or
         #     `GSUITE` IdP. Format:
         #     `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
+        # @!attribute [rw] is_infobot_faq_data_store
+        #   @return [::Boolean]
+        #     Optional. If set, this DataStore is an Infobot FAQ DataStore.
+        # @!attribute [rw] federated_search_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig]
+        #     Optional. If set, this DataStore is a federated search DataStore.
+        # @!attribute [rw] configurable_billing_approach
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::ConfigurableBillingApproach]
+        #     Optional. Configuration for configurable billing approach. See
+        # @!attribute [r] configurable_billing_approach_update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when configurable_billing_approach was last
+        #     updated.
+        # @!attribute [rw] data_protection_policy
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataProtectionPolicy]
+        #     Optional. Specifies the data protection policy for the data store.
         class DataStore
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -169,6 +188,146 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Stores information regarding the serving configurations at DataStore level.
+          # @!attribute [rw] disabled_for_serving
+          #   @return [::Boolean]
+          #     Optional. If set true, the DataStore will not be available for serving
+          #     search requests.
+          class ServingConfigDataStore
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Stores information for federated search.
+          # @!attribute [rw] alloy_db_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig::AlloyDbConfig]
+          #     AlloyDB config. If set, this DataStore is connected to AlloyDB.
+          #
+          #     Note: The following fields are mutually exclusive: `alloy_db_config`, `third_party_oauth_config`, `notebooklm_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] third_party_oauth_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig::ThirdPartyOauthConfig]
+          #     Third Party OAuth config. If set, this DataStore is connected to a
+          #     third party application.
+          #
+          #     Note: The following fields are mutually exclusive: `third_party_oauth_config`, `alloy_db_config`, `notebooklm_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] notebooklm_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig::NotebooklmConfig]
+          #     NotebookLM config. If set, this DataStore is connected to
+          #     NotebookLM Enterprise.
+          #
+          #     Note: The following fields are mutually exclusive: `notebooklm_config`, `alloy_db_config`, `third_party_oauth_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          class FederatedSearchConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Stores information for connecting to AlloyDB.
+            # @!attribute [rw] alloydb_connection_config
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbConnectionConfig]
+            #     Required. Configuration for connecting to AlloyDB.
+            # @!attribute [rw] alloydb_ai_nl_config
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbAiNaturalLanguageConfig]
+            #     Optional. Configuration for Magic.
+            # @!attribute [rw] returned_fields
+            #   @return [::Array<::String>]
+            #     Optional. Fields to be returned in the search results. If empty, all
+            #     fields will be returned.
+            class AlloyDbConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Configuration for connecting to AlloyDB.
+              # @!attribute [rw] instance
+              #   @return [::String]
+              #     Required. The AlloyDB instance to connect to.
+              # @!attribute [rw] database
+              #   @return [::String]
+              #     Required. The AlloyDB database to connect to.
+              # @!attribute [rw] user
+              #   @return [::String]
+              #     Required. Database user.
+              #
+              #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
+              #     the user will be inferred on the AlloyDB side, based on the
+              #     authenticated user.
+              # @!attribute [rw] password
+              #   @return [::String]
+              #     Required. Database password.
+              #
+              #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
+              #     the password will be inferred on the AlloyDB side, based on the
+              #     authenticated user.
+              # @!attribute [rw] auth_mode
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbConnectionConfig::AuthMode]
+              #     Optional. Auth mode.
+              # @!attribute [rw] enable_psvs
+              #   @return [::Boolean]
+              #     Optional. If true, enable PSVS for AlloyDB.
+              class AlloyDbConnectionConfig
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Auth mode.
+                module AuthMode
+                  AUTH_MODE_UNSPECIFIED = 0
+
+                  # Uses P4SA when VAIS talks to AlloyDB.
+                  AUTH_MODE_SERVICE_ACCOUNT = 1
+
+                  # Uses EUC when VAIS talks to AlloyDB.
+                  AUTH_MODE_END_USER_ACCOUNT = 2
+                end
+              end
+
+              # Configuration for AlloyDB AI Natural Language.
+              # @!attribute [rw] nl_config_id
+              #   @return [::String]
+              #     Optional. AlloyDb AI NL config id, i.e. the value that was used for
+              #     calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be
+              #     empty.
+              class AlloyDbAiNaturalLanguageConfig
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Stores information for third party applicationOAuth.
+            # @!attribute [rw] app_name
+            #   @return [::String]
+            #     Optional. The type of the application. E.g., "jira", "box", etc.
+            # @!attribute [rw] instance_name
+            #   @return [::String]
+            #     Optional. The instance name identifying the 3P app, e.g.,
+            #     "<tenant>-my". This is different from the instance_uri which is the
+            #     full URL of the 3P app e.g., "https://<tenant>-my.sharepoint.com".
+            class ThirdPartyOauthConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Config for connecting to NotebookLM Enterprise.
+            # @!attribute [rw] search_config
+            #   @return [::String]
+            #     Required. Search config name.
+            #
+            #     Format: projects/*/locations/global/notebookLmSearchConfigs/*
+            # @!attribute [rw] notebooks
+            #   @return [::Array<::String>]
+            #     Optional. Restricts this data store to the given notebooks. When empty,
+            #     the data store covers every notebook the querying user can access,
+            #     which is the existing behaviour.
+            #
+            #     Each entry is a full notebook resource name, such as
+            #     `projects/*/locations/*/notebooks/*`.
+            #
+            #     Scoping is enforced on results as well as requested upstream, so a
+            #     notebook outside this list cannot appear in a search response through
+            #     this data store even if the backend returns one.
+            class NotebooklmConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # Content config of the data store.
           module ContentConfig
             # Default value.
@@ -190,6 +349,19 @@ module Google
             # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
             GOOGLE_WORKSPACE = 4
           end
+
+          # Configuration for configurable billing approach.
+          module ConfigurableBillingApproach
+            # Default value. For Spark and non-Spark non-configurable billing approach.
+            CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0
+
+            # Use the subscription base + overage billing for indexing core for non
+            # embedding storage.
+            CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE = 1
+
+            # Use the consumption pay-as-you-go billing for embedding storage add-on.
+            CONFIGURABLE_CONSUMPTION_EMBEDDING = 2
+          end
         end
 
         # Configuration data for advance site search.
@@ -235,9 +407,11 @@ module Google
         # @!attribute [rw] type
         #   @return [::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig::Type]
         #     The Google Workspace data source.
-        # @!attribute [rw] dasher_customer_id
+        # @!attribute [r] dasher_customer_id
         #   @return [::String]
-        #     Obfuscated Dasher customer ID.
+        #     Output only. Obfuscated Dasher customer ID. Derived by the server from
+        #     the project's GCP organization at data store creation time; any value
+        #     supplied in the request payload is ignored.
         # @!attribute [rw] super_admin_service_account
         #   @return [::String]
         #     Optional. The super admin service account for the workspace that will be
@@ -280,6 +454,9 @@ module Google
 
             # Workspace Data Store contains People data
             GOOGLE_PEOPLE = 8
+
+            # Workspace Data Store contains all Workspace apps data
+            GOOGLE_WORKSPACE = 9
           end
         end
       end

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

@@ -74,11 +74,14 @@ module Google
         #     Access control information for the document.
         # @!attribute [r] index_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The last time the document was indexed. If this field is set,
-        #     the document could be returned in search results.
+        #     Output only. The time when the document was last indexed.
         #
-        #     This field is OUTPUT_ONLY. If this field is not populated, it means the
-        #     document has never been indexed.
+        #     If this field is populated, it means the document has been indexed.
+        #     While documents typically become searchable within seconds of indexing,
+        #     it can sometimes take up to a few hours.
+        #
+        #     If this field is not populated, it means the document has never been
+        #     indexed.
         # @!attribute [r] index_status
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Document::IndexStatus]
         #     Output only. The index status of the document.
@@ -226,6 +229,8 @@ module Google
           #   @return [::Google::Protobuf::Timestamp]
           #     The time when the document was indexed.
           #     If this field is populated, it means the document has been indexed.
+          #     While documents typically become searchable within seconds of indexing,
+          #     it can sometimes take up to a few hours.
           # @!attribute [rw] error_samples
           #   @return [::Array<::Google::Rpc::Status>]
           #     A sample of errors encountered while indexing the document.

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

@@ -140,6 +140,9 @@ module Google
             #   @return [::Boolean]
             #     Optional. If true, the LLM based annotation is added to the image
             #     during parsing.
+            # @!attribute [rw] enable_llm_layout_parsing
+            #   @return [::Boolean]
+            #     Optional. If true, the pdf layout will be refined using an LLM.
             # @!attribute [rw] structured_content_types
             #   @return [::Array<::String>]
             #     Optional. Contains the required structure types to extract from the
@@ -155,6 +158,10 @@ module Google
             # @!attribute [rw] exclude_html_ids
             #   @return [::Array<::String>]
             #     Optional. List of HTML ids to exclude from the parsed content.
+            # @!attribute [rw] enable_get_processed_document
+            #   @return [::Boolean]
+            #     Optional. If true, the processed document will be made available for
+            #     the GetProcessedDocument API.
             class LayoutParsingConfig
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods