google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0

data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb

@@ -35,6 +35,9 @@ module Google
             # customer's website.
             #
             class Client
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
 
@@ -257,12 +260,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get_document.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.get_document.timeout,
@@ -312,7 +316,7 @@ module Google
               #   @param page_size [::Integer]
               #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
               #     to return. If unspecified, defaults to 100. The maximum allowed value is
-              #     1000. Values above 1000 will be coerced to 1000.
+              #     1000. Values above 1000 are set to 1000.
               #
               #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
               #   @param page_token [::String]
@@ -364,12 +368,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.list_documents.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.list_documents.timeout,
@@ -415,8 +420,8 @@ module Google
               #     create.
               #   @param document_id [::String]
               #     Required. The ID to use for the
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}, which will become
-              #     the final component of the
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}, which becomes the
+              #     final component of the
               #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name}.
               #
               #     If the caller does not have permission to create the
@@ -465,12 +470,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.create_document.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.create_document.timeout,
@@ -502,7 +508,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload update_document(document: nil, allow_missing: nil)
+              # @overload update_document(document: nil, allow_missing: nil, update_mask: nil)
               #   Pass arguments to `update_document` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -519,10 +525,12 @@ module Google
               #     {::Google::Cloud::DiscoveryEngine::V1beta::UpdateDocumentRequest#allow_missing allow_missing}
               #     is not set, a `NOT_FOUND` error is returned.
               #   @param allow_missing [::Boolean]
-              #     If set to true, and the
+              #     If set to `true` and the
               #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not found, a
-              #     new {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} will be
-              #     created.
+              #     new {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is be created.
+              #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+              #     Indicates which fields in the provided imported 'document' to update. If
+              #     not set, by default updates all fields.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Document]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -557,12 +565,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.update_document.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.update_document.timeout,
@@ -644,12 +653,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.delete_document.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.delete_document.timeout,
@@ -671,7 +681,7 @@ module Google
               ##
               # Bulk import of multiple
               # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s. Request
-              # processing may be synchronous. Non-existing items will be created.
+              # processing may be synchronous. Non-existing items are created.
               #
               # Note: It is possible for a subset of the
               # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s to be
@@ -687,7 +697,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, auto_generate_ids: nil, id_field: nil)
+              # @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, fhir_store_source: nil, spanner_source: nil, cloud_sql_source: nil, firestore_source: nil, bigtable_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, update_mask: nil, auto_generate_ids: nil, id_field: nil)
               #   Pass arguments to `import_documents` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -698,6 +708,16 @@ module Google
               #     Cloud Storage location for the input content.
               #   @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
               #     BigQuery input source.
+              #   @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource, ::Hash]
+              #     FhirStore input source.
+              #   @param spanner_source [::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource, ::Hash]
+              #     Spanner input source.
+              #   @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource, ::Hash]
+              #     Cloud SQL input source.
+              #   @param firestore_source [::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource, ::Hash]
+              #     Firestore input source.
+              #   @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource, ::Hash]
+              #     Cloud Bigtable input source.
               #   @param parent [::String]
               #     Required. The parent branch resource name, such as
               #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -708,6 +728,9 @@ module Google
               #     The mode of reconciliation between existing documents and the documents to
               #     be imported. Defaults to
               #     {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
+              #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+              #     Indicates which fields in the provided imported documents to update. If
+              #     not set, the default is to update all fields.
               #   @param auto_generate_ids [::Boolean]
               #     Whether to automatically generate IDs for the documents if absent.
               #
@@ -722,44 +745,53 @@ module Google
               #     {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest#id_field id_field},
               #     otherwise, documents without IDs fail to be imported.
               #
-              #     Only set this field when using
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource} or
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource}, and
-              #     when
+              #     Supported data sources:
+              #
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource}.
               #     {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource#data_schema GcsSource.data_schema}
-              #     or
+              #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource}.
               #     {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource#data_schema BigQuerySource.data_schema}
-              #     is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+              #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource SpannerSource}.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource CloudSqlSource}.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource FirestoreSource}.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource BigtableSource}.
               #   @param id_field [::String]
-              #     The field in the Cloud Storage and BigQuery sources that indicates the
-              #     unique IDs of the documents.
+              #     The field indicates the ID field or column to be used as unique IDs of
+              #     the documents.
               #
               #     For {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource} it is the
               #     key of the JSON field. For instance, `my_id` for JSON `{"my_id":
-              #     "some_uuid"}`. For
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource} it is
-              #     the column name of the BigQuery table where the unique ids are stored.
+              #     "some_uuid"}`. For others, it may be the column name of the table where the
+              #     unique ids are stored.
               #
-              #     The values of the JSON field or the BigQuery column are used as the
+              #     The values of the JSON field or the table column are used as the
               #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id}s. The JSON
-              #     field or the BigQuery column must be of string type, and the values must be
+              #     field or the table column must be of string type, and the values must be
               #     set as valid strings conform to
               #     [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
               #     Otherwise, documents without valid IDs fail to be imported.
               #
-              #     Only set this field when using
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource} or
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource}, and
-              #     when
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource#data_schema GcsSource.data_schema}
-              #     or
-              #     {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource#data_schema BigQuerySource.data_schema}
-              #     is `custom`. And only set this field when
+              #     Only set this field when
               #     {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
               #     is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
               #
               #     If it is unset, a default value `_id` is used when importing from the
               #     allowed data sources.
+              #
+              #     Supported data sources:
+              #
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource}.
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource#data_schema GcsSource.data_schema}
+              #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource}.
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource#data_schema BigQuerySource.data_schema}
+              #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource SpannerSource}.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource CloudSqlSource}.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource FirestoreSource}.
+              #     * {::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource BigtableSource}.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -801,12 +833,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.import_documents.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.import_documents.timeout,
@@ -911,12 +944,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.purge_documents.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.purge_documents.timeout,

data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb

@@ -26,6 +26,9 @@ module Google
           module Rest
             # Service that implements Longrunning Operations API.
             class Operations
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
 
@@ -181,12 +184,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.list_operations.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
@@ -269,12 +273,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get_operation.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
@@ -351,12 +356,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.delete_operation.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.delete_operation.timeout,
@@ -438,12 +444,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.cancel_operation.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
@@ -1060,10 +1067,18 @@ module Google
                 transcoder = Gapic::Rest::GrpcTranscoder.new
                                                         .with_bindings(
                                                           uri_method: :post,
-                                                          uri_template: "/v1/{name}:cancel",
+                                                          uri_template: "/v1beta/{name}:cancel",
                                                           body: "*",
                                                           matches: [
-                                                            ["name", %r{^operations(?:/.*)?$}, true]
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{name}:cancel",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
                 transcoder.transcode request_pb