google-cloud-translate-v3 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1f355271c900cd2645945791321036faa54809da759453b828a6998d4c58b9
-  data.tar.gz: 37442cdf328615d651afa9da9639be31f94cd42da89fd451486ba56ea672e0c4
+  metadata.gz: 33372dd6501c9fe6e451d60c565c8bcd64344f2f1df8e9f405d90cf9f176e102
+  data.tar.gz: 42824b612fa260da46291defafe29d98d845b4d620344fc30c9019223549c5e1
 SHA512:
-  metadata.gz: e10eefa73af782890358a319f1206c3392e67adb0be23d440c33b7f10756645229b97b245a09619e0d7df768f7cf7ae309c083b623bc2c7a7d9a7682e3983cab
-  data.tar.gz: 17025315d4d3ce8acb1d57aa79d0736050dea9adfcdef3b14a362802e0cd708dc4ff5d2a0d4a4da7ef327f22c5ad95a50669d7da463b03916cebf4b4692a35ce
+  metadata.gz: 38a8b216b0a9d3ae29f704b05fa2135b1cd483411030d565fc52481c55c8ddf5072efed968efb83e909f1cd6932de5df7c5530d7200fac3354ff780cb4ddaf3e
+  data.tar.gz: '075179c740268f59965a56883090c1e6bbe7eccbdc1b184ef93c75fa115d42ee96810677812c4b6f418bbcc6a9c4f6374537e4360fc3a37a009e174495f6fa39'

data/lib/google/cloud/translate/v3/rest.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "google/cloud/translate/v3/translation_service/rest"
+require "google/cloud/translate/v3/version"
+
+module Google
+  module Cloud
+    module Translate
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/translate/v3/rest"
+      #     client = ::Google::Cloud::Translate::V3::TranslationService::Rest::Client.new
+      #
+      module V3
+      end
+    end
+  end
+end

data/lib/google/cloud/translate/v3/translation_service/client.rb

@@ -209,20 +209,19 @@ module Google
             #
             #   @param contents [::Array<::String>]
             #     Required. The content of the input in string format.
-            #     We recommend the total content be less than 30k codepoints. The max length
-            #     of this field is 1024.
-            #     Use BatchTranslateText for larger text.
+            #     We recommend the total content be less than 30,000 codepoints. The max
+            #     length of this field is 1024. Use BatchTranslateText for larger text.
             #   @param mime_type [::String]
             #     Optional. The format of the source text, for example, "text/html",
             #      "text/plain". If left blank, the MIME type defaults to "text/html".
             #   @param source_language_code [::String]
-            #     Optional. The BCP-47 language code of the input text if
+            #     Optional. The ISO-639 language code of the input text if
             #     known, for example, "en-US" or "sr-Latn". Supported language codes are
             #     listed in Language Support. If the source language isn't specified, the API
             #     attempts to identify the source language automatically and returns the
             #     source language within the response.
             #   @param target_language_code [::String]
-            #     Required. The BCP-47 language code to use for translation of the input
+            #     Required. The ISO-639 language code to use for translation of the input
             #     text, set to one of the language codes listed in Language Support.
             #   @param parent [::String]
             #     Required. Project or location to make a call. Must refer to a caller's
@@ -583,7 +582,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload translate_document(parent: nil, source_language_code: nil, target_language_code: nil, document_input_config: nil, document_output_config: nil, model: nil, glossary_config: nil, labels: nil)
+            # @overload translate_document(parent: nil, source_language_code: nil, target_language_code: nil, document_input_config: nil, document_output_config: nil, model: nil, glossary_config: nil, labels: nil, customized_attribution: nil, is_translate_native_pdf_only: nil, enable_shadow_removal_native_pdf: nil)
             #   Pass arguments to `translate_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).
@@ -602,14 +601,14 @@ module Google
             #     Models and glossaries must be within the same region (have the same
             #     location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
             #   @param source_language_code [::String]
-            #     Optional. The BCP-47 language code of the input document if known, for
+            #     Optional. The ISO-639 language code of the input document if known, for
             #     example, "en-US" or "sr-Latn". Supported language codes are listed in
             #     Language Support. If the source language isn't specified, the API attempts
             #     to identify the source language automatically and returns the source
             #     language within the response. Source language must be specified if the
             #     request contains a glossary or a custom model.
             #   @param target_language_code [::String]
-            #     Required. The BCP-47 language code to use for translation of the input
+            #     Required. The ISO-639 language code to use for translation of the input
             #     document, set to one of the language codes listed in Language Support.
             #   @param document_input_config [::Google::Cloud::Translate::V3::DocumentInputConfig, ::Hash]
             #     Required. Input configurations.
@@ -647,6 +646,19 @@ module Google
             #
             #     See https://cloud.google.com/translate/docs/advanced/labels for more
             #     information.
+            #   @param customized_attribution [::String]
+            #     Optional. This flag is to support user customized attribution.
+            #     If not provided, the default is `Machine Translated by Google`.
+            #     Customized attribution should follow rules in
+            #     https://cloud.google.com/translate/attribution#attribution_and_logos
+            #   @param is_translate_native_pdf_only [::Boolean]
+            #     Optional. If true, the page limit of online native pdf translation is 300
+            #     and only native pdf pages will be translated.
+            #   @param enable_shadow_removal_native_pdf [::Boolean]
+            #     Optional. If true, use the text removal to remove the shadow text on
+            #     background image for native pdf translation.
+            #     Shadow removal feature can only be enabled when
+            #     is_translate_native_pdf_only is false
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Translate::V3::TranslateDocumentResponse]
@@ -809,14 +821,14 @@ module Google
             #   # Call the batch_translate_text method.
             #   result = client.batch_translate_text request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def batch_translate_text request, options = nil
@@ -880,7 +892,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload batch_translate_document(parent: nil, source_language_code: nil, target_language_codes: nil, input_configs: nil, output_config: nil, models: nil, glossaries: nil, format_conversions: nil)
+            # @overload batch_translate_document(parent: nil, source_language_code: nil, target_language_codes: nil, input_configs: nil, output_config: nil, models: nil, glossaries: nil, format_conversions: nil, customized_attribution: nil)
             #   Pass arguments to `batch_translate_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).
@@ -896,11 +908,11 @@ module Google
             #     the same location-id) can be used, otherwise an INVALID_ARGUMENT (400)
             #     error is returned.
             #   @param source_language_code [::String]
-            #     Required. The BCP-47 language code of the input document if known, for
+            #     Required. The ISO-639 language code of the input document if known, for
             #     example, "en-US" or "sr-Latn". Supported language codes are listed in
-            #     Language Support (https://cloud.google.com/translate/docs/languages).
+            #     [Language Support](https://cloud.google.com/translate/docs/languages).
             #   @param target_language_codes [::Array<::String>]
-            #     Required. The BCP-47 language code to use for translation of the input
+            #     Required. The ISO-639 language code to use for translation of the input
             #     document. Specify up to 10 language codes here.
             #   @param input_configs [::Array<::Google::Cloud::Translate::V3::BatchDocumentInputConfig, ::Hash>]
             #     Required. Input configurations.
@@ -940,6 +952,11 @@ module Google
             #
             #     If nothing specified, output files will be in the same format as the
             #     original file.
+            #   @param customized_attribution [::String]
+            #     Optional. This flag is to support user customized attribution.
+            #     If not provided, the default is `Machine Translated by Google`.
+            #     Customized attribution should follow rules in
+            #     https://cloud.google.com/translate/attribution#attribution_and_logos
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -961,14 +978,14 @@ module Google
             #   # Call the batch_translate_document method.
             #   result = client.batch_translate_document request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def batch_translate_document request, options = nil
@@ -1057,14 +1074,14 @@ module Google
             #   # Call the create_glossary method.
             #   result = client.create_glossary request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def create_glossary request, options = nil
@@ -1176,13 +1193,11 @@ module Google
             #   # Call the list_glossaries method.
             #   result = client.list_glossaries request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Translate::V3::Glossary.
-            #     p response
+            #     p item
             #   end
             #
             def list_glossaries request, options = nil
@@ -1356,14 +1371,14 @@ module Google
             #   # Call the delete_glossary method.
             #   result = client.delete_glossary request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def delete_glossary request, options = nil

data/lib/google/cloud/translate/v3/translation_service/operations.rb

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil
@@ -567,6 +565,14 @@ module Google
                 gapic_version: ::Google::Cloud::Translate::V3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
               options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.wait_operation.retry_policy