google-cloud-automl-v1 0.7.0 → 0.9.0

data/lib/google/cloud/automl/v1/automl/rest/client.rb

@@ -45,6 +45,9 @@ module Google
             # snake_case or dash-case, either of those cases is accepted.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "automl.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -168,6 +171,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @auto_ml_stub.universe_domain
+              end
+
               ##
               # Create a new AutoMl REST client object.
               #
@@ -195,8 +207,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)
@@ -210,9 +223,15 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                 end
 
-                @auto_ml_stub = ::Google::Cloud::AutoML::V1::AutoML::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                @auto_ml_stub = ::Google::Cloud::AutoML::V1::AutoML::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
               end
 
               ##
@@ -253,6 +272,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::CreateDatasetRequest.new
+              #
+              #   # Call the create_dataset method.
+              #   result = client.create_dataset 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 create_dataset request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -316,6 +358,22 @@ module Google
               # @return [::Google::Cloud::AutoML::V1::Dataset]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::GetDatasetRequest.new
+              #
+              #   # Call the get_dataset method.
+              #   result = client.get_dataset request
+              #
+              #   # The returned object is of type Google::Cloud::AutoML::V1::Dataset.
+              #   p result
+              #
               def get_dataset request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -394,6 +452,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AutoML::V1::Dataset>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::ListDatasetsRequest.new
+              #
+              #   # Call the list_datasets method.
+              #   result = client.list_datasets 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::AutoML::V1::Dataset.
+              #     p item
+              #   end
+              #
               def list_datasets request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -459,6 +537,22 @@ module Google
               # @return [::Google::Cloud::AutoML::V1::Dataset]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::UpdateDatasetRequest.new
+              #
+              #   # Call the update_dataset method.
+              #   result = client.update_dataset request
+              #
+              #   # The returned object is of type Google::Cloud::AutoML::V1::Dataset.
+              #   p result
+              #
               def update_dataset request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -525,6 +619,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::DeleteDatasetRequest.new
+              #
+              #   # Call the delete_dataset method.
+              #   result = client.delete_dataset 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 delete_dataset request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -600,6 +717,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::ImportDataRequest.new
+              #
+              #   # Call the import_data method.
+              #   result = client.import_data 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_data request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -667,6 +807,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::ExportDataRequest.new
+              #
+              #   # Call the export_data method.
+              #   result = client.export_data 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 export_data request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -730,6 +893,22 @@ module Google
               # @return [::Google::Cloud::AutoML::V1::AnnotationSpec]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::GetAnnotationSpecRequest.new
+              #
+              #   # Call the get_annotation_spec method.
+              #   result = client.get_annotation_spec request
+              #
+              #   # The returned object is of type Google::Cloud::AutoML::V1::AnnotationSpec.
+              #   p result
+              #
               def get_annotation_spec request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -798,6 +977,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::CreateModelRequest.new
+              #
+              #   # Call the create_model method.
+              #   result = client.create_model 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 create_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -861,6 +1063,22 @@ module Google
               # @return [::Google::Cloud::AutoML::V1::Model]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::GetModelRequest.new
+              #
+              #   # Call the get_model method.
+              #   result = client.get_model request
+              #
+              #   # The returned object is of type Google::Cloud::AutoML::V1::Model.
+              #   p result
+              #
               def get_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -940,6 +1158,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AutoML::V1::Model>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::ListModelsRequest.new
+              #
+              #   # Call the list_models method.
+              #   result = client.list_models 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::AutoML::V1::Model.
+              #     p item
+              #   end
+              #
               def list_models request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1007,6 +1245,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::DeleteModelRequest.new
+              #
+              #   # Call the delete_model method.
+              #   result = client.delete_model 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 delete_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1072,6 +1333,22 @@ module Google
               # @return [::Google::Cloud::AutoML::V1::Model]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::UpdateModelRequest.new
+              #
+              #   # Call the update_model method.
+              #   result = client.update_model request
+              #
+              #   # The returned object is of type Google::Cloud::AutoML::V1::Model.
+              #   p result
+              #
               def update_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1148,6 +1425,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::DeployModelRequest.new
+              #
+              #   # Call the deploy_model method.
+              #   result = client.deploy_model 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 deploy_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1217,6 +1517,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::UndeployModelRequest.new
+              #
+              #   # Call the undeploy_model method.
+              #   result = client.undeploy_model 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 undeploy_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1288,6 +1611,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::ExportModelRequest.new
+              #
+              #   # Call the export_model method.
+              #   result = client.export_model 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 export_model request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1351,6 +1697,22 @@ module Google
               # @return [::Google::Cloud::AutoML::V1::ModelEvaluation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::GetModelEvaluationRequest.new
+              #
+              #   # Call the get_model_evaluation method.
+              #   result = client.get_model_evaluation request
+              #
+              #   # The returned object is of type Google::Cloud::AutoML::V1::ModelEvaluation.
+              #   p result
+              #
               def get_model_evaluation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1434,6 +1796,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AutoML::V1::ModelEvaluation>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/automl/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AutoML::V1::AutoML::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AutoML::V1::ListModelEvaluationsRequest.new
+              #
+              #   # Call the list_model_evaluations method.
+              #   result = client.list_model_evaluations 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::AutoML::V1::ModelEvaluation.
+              #     p item
+              #   end
+              #
               def list_model_evaluations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1500,9 +1882,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"automl.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
@@ -1539,13 +1921,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 = "automl.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 }
@@ -1557,6 +1946,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