google-cloud-vision-v1 0.11.1 → 0.13.0

data/lib/google/cloud/vision/v1/product_search/rest/client.rb

@@ -45,6 +45,9 @@ module Google
             #   `projects/*/locations/*/products/*/referenceImages/*`
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "vision.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -200,6 +203,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @product_search_stub.universe_domain
+              end
+
               ##
               # Create a new ProductSearch REST client object.
               #
@@ -227,8 +239,9 @@ module Google
                 credentials = @config.credentials
                 # 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.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_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)
@@ -242,9 +255,15 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                 end
 
-                @product_search_stub = ::Google::Cloud::Vision::V1::ProductSearch::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                @product_search_stub = ::Google::Cloud::Vision::V1::ProductSearch::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
               end
 
               ##
@@ -297,6 +316,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::ProductSet]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::CreateProductSetRequest.new
+              #
+              #   # Call the create_product_set method.
+              #   result = client.create_product_set request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::ProductSet.
+              #   p result
+              #
               def create_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -370,6 +405,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Vision::V1::ProductSet>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::ListProductSetsRequest.new
+              #
+              #   # Call the list_product_sets method.
+              #   result = client.list_product_sets request
+              #
+              #   # 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::Vision::V1::ProductSet.
+              #     p item
+              #   end
+              #
               def list_product_sets request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -440,6 +495,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::ProductSet]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::GetProductSetRequest.new
+              #
+              #   # Call the get_product_set method.
+              #   result = client.get_product_set request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::ProductSet.
+              #   p result
+              #
               def get_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -514,6 +585,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::ProductSet]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::UpdateProductSetRequest.new
+              #
+              #   # Call the update_product_set method.
+              #   result = client.update_product_set request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::ProductSet.
+              #   p result
+              #
               def update_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -582,6 +669,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::DeleteProductSetRequest.new
+              #
+              #   # Call the delete_product_set method.
+              #   result = client.delete_product_set request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -661,6 +764,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::Product]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::CreateProductRequest.new
+              #
+              #   # Call the create_product method.
+              #   result = client.create_product request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::Product.
+              #   p result
+              #
               def create_product request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -734,6 +853,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Vision::V1::Product>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::ListProductsRequest.new
+              #
+              #   # Call the list_products method.
+              #   result = client.list_products request
+              #
+              #   # 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::Vision::V1::Product.
+              #     p item
+              #   end
+              #
               def list_products request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -804,6 +943,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::Product]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::GetProductRequest.new
+              #
+              #   # Call the get_product method.
+              #   result = client.get_product request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::Product.
+              #   p result
+              #
               def get_product request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -887,6 +1042,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::Product]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::UpdateProductRequest.new
+              #
+              #   # Call the update_product method.
+              #   result = client.update_product request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::Product.
+              #   p result
+              #
               def update_product request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -956,6 +1127,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::DeleteProductRequest.new
+              #
+              #   # Call the delete_product method.
+              #   result = client.delete_product request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_product request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1047,6 +1234,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::ReferenceImage]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::CreateReferenceImageRequest.new
+              #
+              #   # Call the create_reference_image method.
+              #   result = client.create_reference_image request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::ReferenceImage.
+              #   p result
+              #
               def create_reference_image request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1118,6 +1321,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::DeleteReferenceImageRequest.new
+              #
+              #   # Call the delete_reference_image method.
+              #   result = client.delete_reference_image request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_reference_image request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1196,6 +1415,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Vision::V1::ReferenceImage>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::ListReferenceImagesRequest.new
+              #
+              #   # Call the list_reference_images method.
+              #   result = client.list_reference_images request
+              #
+              #   # 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::Vision::V1::ReferenceImage.
+              #     p item
+              #   end
+              #
               def list_reference_images request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1266,6 +1505,22 @@ module Google
               # @return [::Google::Cloud::Vision::V1::ReferenceImage]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::GetReferenceImageRequest.new
+              #
+              #   # Call the get_reference_image method.
+              #   result = client.get_reference_image request
+              #
+              #   # The returned object is of type Google::Cloud::Vision::V1::ReferenceImage.
+              #   p result
+              #
               def get_reference_image request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1343,6 +1598,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::AddProductToProductSetRequest.new
+              #
+              #   # Call the add_product_to_product_set method.
+              #   result = client.add_product_to_product_set request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def add_product_to_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1413,6 +1684,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest.new
+              #
+              #   # Call the remove_product_from_product_set method.
+              #   result = client.remove_product_from_product_set request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def remove_product_from_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1488,6 +1775,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Vision::V1::Product>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::ListProductsInProductSetRequest.new
+              #
+              #   # Call the list_products_in_product_set method.
+              #   result = client.list_products_in_product_set request
+              #
+              #   # 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::Vision::V1::Product.
+              #     p item
+              #   end
+              #
               def list_products_in_product_set request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1565,6 +1872,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::ImportProductSetsRequest.new
+              #
+              #   # Call the import_product_sets method.
+              #   result = client.import_product_sets request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def import_product_sets request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1661,6 +1991,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/vision/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Vision::V1::ProductSearch::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Vision::V1::PurgeProductsRequest.new
+              #
+              #   # Call the purge_products method.
+              #   result = client.purge_products request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def purge_products request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1727,9 +2080,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"vision.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
@@ -1766,13 +2119,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
 
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                 DEFAULT_ENDPOINT = "vision.googleapis.com"
 
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed.any? { |klass| klass === value }
@@ -1784,6 +2144,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
 
                 # @private
                 def initialize parent_config = nil