google-cloud-document_ai-v1beta3 0.9.0 → 0.9.4

data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb

@@ -44,13 +44,12 @@ module Google
             # See {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all DocumentProcessorService clients:
-            #
-            #     ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all DocumentProcessorService clients
+            #   ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -70,26 +69,17 @@ module Google
 
                 default_config.rpcs.process_document.timeout = 120.0
                 default_config.rpcs.process_document.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.batch_process_documents.timeout = 120.0
                 default_config.rpcs.batch_process_documents.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.review_document.timeout = 120.0
                 default_config.rpcs.review_document.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config
@@ -121,19 +111,15 @@ module Google
             ##
             # Create a new DocumentProcessorService client object.
             #
-            # ## Examples
-            #
-            # To create a new DocumentProcessorService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            # @example
             #
-            # To create a new DocumentProcessorService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
             #
-            #     client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the DocumentProcessorService client.
             # @yieldparam config [Client::Configuration]
@@ -153,14 +139,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -168,6 +153,7 @@ module Google
 
               @operations_client = Operations.new do |config|
                 config.credentials = credentials
+                config.quota_project = @quota_project_id
                 config.endpoint = @config.endpoint
               end
 
@@ -227,6 +213,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::ProcessRequest.new
+            #
+            #   # Call the process_document method.
+            #   result = client.process_document request
+            #
+            #   # The returned object is of type Google::Cloud::DocumentAI::V1beta3::ProcessResponse.
+            #   p result
+            #
             def process_document request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -244,16 +245,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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.process_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.process_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :process_document, request, options: options do |response, operation|
@@ -305,6 +310,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest.new
+            #
+            #   # Call the batch_process_documents method.
+            #   result = client.batch_process_documents 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:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def batch_process_documents request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -322,16 +349,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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.batch_process_documents.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_process_documents.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :batch_process_documents, request, options: options do |response, operation|
@@ -373,6 +404,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesRequest.new
+            #
+            #   # Call the fetch_processor_types method.
+            #   result = client.fetch_processor_types request
+            #
+            #   # The returned object is of type Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse.
+            #   p result
+            #
             def fetch_processor_types request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -390,16 +436,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.fetch_processor_types.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.fetch_processor_types.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :fetch_processor_types, request, options: options do |response, operation|
@@ -447,6 +497,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::ListProcessorsRequest.new
+            #
+            #   # Call the list_processors method.
+            #   result = client.list_processors 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|
+            #     # Each element is of type ::Google::Cloud::DocumentAI::V1beta3::Processor.
+            #     p response
+            #   end
+            #
             def list_processors request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -464,16 +535,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.list_processors.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_processors.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :list_processors, request, options: options do |response, operation|
@@ -519,6 +594,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::CreateProcessorRequest.new
+            #
+            #   # Call the create_processor method.
+            #   result = client.create_processor request
+            #
+            #   # The returned object is of type Google::Cloud::DocumentAI::V1beta3::Processor.
+            #   p result
+            #
             def create_processor request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -536,16 +626,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.create_processor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_processor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :create_processor, request, options: options do |response, operation|
@@ -586,6 +680,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::DeleteProcessorRequest.new
+            #
+            #   # Call the delete_processor method.
+            #   result = client.delete_processor 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:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def delete_processor request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -603,16 +719,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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.delete_processor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_processor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :delete_processor, request, options: options do |response, operation|
@@ -653,6 +773,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::EnableProcessorRequest.new
+            #
+            #   # Call the enable_processor method.
+            #   result = client.enable_processor 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:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def enable_processor request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -670,16 +812,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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.enable_processor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.enable_processor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :enable_processor, request, options: options do |response, operation|
@@ -720,6 +866,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::DisableProcessorRequest.new
+            #
+            #   # Call the disable_processor method.
+            #   result = client.disable_processor 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:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def disable_processor request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -737,16 +905,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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.disable_processor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.disable_processor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :disable_processor, request, options: options do |response, operation|
@@ -797,6 +969,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest.new
+            #
+            #   # Call the review_document method.
+            #   result = client.review_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:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def review_document request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -814,16 +1008,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "human_review_config" => request.human_review_config
-              }
+              header_params = {}
+              if request.human_review_config
+                header_params["human_review_config"] = request.human_review_config
+              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.review_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.review_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :review_document, request, options: options do |response, operation|
@@ -848,22 +1046,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for process_document
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.process_document.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.process_document.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # process_document to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.process_document.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.process_document.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.