lib/google/cloud/automl/v1beta1/prediction_service/client.rb in google-cloud-automl-v1beta1-0.1.0 vs lib/google/cloud/automl/v1beta1/prediction_service/client.rb in google-cloud-automl-v1beta1-0.1.1

- old
+ new

@@ -39,19 +39,19 @@ attr_reader :prediction_service_stub ## # Configure the PredictionService Client class. # - # See {Google::Cloud::AutoML::V1beta1::PredictionService::Client::Configuration} + # See {::Google::Cloud::AutoML::V1beta1::PredictionService::Client::Configuration} # for a description of the configuration fields. # # ## Example # # To modify the configuration for all PredictionService clients: # - # Google::Cloud::AutoML::V1beta1::PredictionService::Client.configure do |config| - # config.timeout = 10_000 + # ::Google::Cloud::AutoML::V1beta1::PredictionService::Client.configure do |config| + # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # @@ -83,11 +83,11 @@ # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # - # See {Google::Cloud::AutoML::V1beta1::PredictionService::Client::Configuration} + # See {::Google::Cloud::AutoML::V1beta1::PredictionService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # @@ -104,17 +104,17 @@ # ## Examples # # To create a new PredictionService client with the default # configuration: # - # client = Google::Cloud::AutoML::V1beta1::PredictionService::Client.new + # client = ::Google::Cloud::AutoML::V1beta1::PredictionService::Client.new # # To create a new PredictionService client with a custom # configuration: # - # client = Google::Cloud::AutoML::V1beta1::PredictionService::Client.new do |config| - # config.timeout = 10_000 + # client = ::Google::Cloud::AutoML::V1beta1::PredictionService::Client.new do |config| + # config.timeout = 10.0 # end # # @yield [config] Configure the PredictionService client. # @yieldparam config [Client::Configuration] # @@ -142,23 +142,23 @@ @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end - @prediction_service_stub = Gapic::ServiceStub.new( - Google::Cloud::AutoML::V1beta1::PredictionService::Stub, + @prediction_service_stub = ::Gapic::ServiceStub.new( + ::Google::Cloud::AutoML::V1beta1::PredictionService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end ## # Get the associated client for long-running operations. # - # @return [Google::Cloud::AutoML::V1beta1::PredictionService::Operations] + # @return [::Google::Cloud::AutoML::V1beta1::PredictionService::Operations] # attr_reader :operations_client # Service calls @@ -183,29 +183,29 @@ # * Text Sentiment - TextSnippet, content up 500 characters, UTF-8 # encoded. # # @overload predict(request, options = nil) # Pass arguments to `predict` via a request object, either of type - # {Google::Cloud::AutoML::V1beta1::PredictRequest} or an equivalent Hash. + # {::Google::Cloud::AutoML::V1beta1::PredictRequest} or an equivalent Hash. # - # @param request [Google::Cloud::AutoML::V1beta1::PredictRequest, Hash] + # @param request [::Google::Cloud::AutoML::V1beta1::PredictRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [Gapic::CallOptions, Hash] + # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload predict(name: nil, payload: nil, params: nil) # Pass arguments to `predict` 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). # - # @param name [String] + # @param name [::String] # Required. Name of the model requested to serve the prediction. - # @param payload [Google::Cloud::AutoML::V1beta1::ExamplePayload, Hash] + # @param payload [::Google::Cloud::AutoML::V1beta1::ExamplePayload, ::Hash] # Required. Payload to perform a prediction on. The payload must match the # problem type that the model was trained to solve. - # @param params [Hash{String => String}] + # @param params [::Hash{::String => ::String}] # Additional domain-specific parameters, any string must be up to 25000 # characters long. # # * For Image Classification: # @@ -224,30 +224,30 @@ # feature_imp<span>ortan</span>ce - (boolean) Whether feature importance # should be populated in the returned TablesAnnotation. # The default is false. # # @yield [response, operation] Access the result along with the RPC operation - # @yieldparam response [Google::Cloud::AutoML::V1beta1::PredictResponse] - # @yieldparam operation [GRPC::ActiveCall::Operation] + # @yieldparam response [::Google::Cloud::AutoML::V1beta1::PredictResponse] + # @yieldparam operation [::GRPC::ActiveCall::Operation] # - # @return [Google::Cloud::AutoML::V1beta1::PredictResponse] + # @return [::Google::Cloud::AutoML::V1beta1::PredictResponse] # - # @raise [Google::Cloud::Error] if the RPC is aborted. + # @raise [::Google::Cloud::Error] if the RPC is aborted. # def predict request, options = nil - raise ArgumentError, "request must be provided" if request.nil? + raise ::ArgumentError, "request must be provided" if request.nil? - request = Gapic::Protobuf.coerce request, to: Google::Cloud::AutoML::V1beta1::PredictRequest + request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::PredictRequest # Converts hash and nil to an options object - options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.predict.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers - metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ + metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Automl::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { @@ -264,51 +264,51 @@ @prediction_service_stub.call_rpc :predict, request, options: options do |response, operation| yield response, operation if block_given? return response end - rescue GRPC::BadStatus => e - raise Google::Cloud::Error.from_error(e) + rescue ::GRPC::BadStatus => e + raise ::Google::Cloud::Error.from_error(e) end ## - # Perform a batch prediction. Unlike the online {Google::Cloud::AutoML::V1beta1::PredictionService::Client#predict Predict}, batch + # Perform a batch prediction. Unlike the online {::Google::Cloud::AutoML::V1beta1::PredictionService::Client#predict Predict}, batch # prediction result won't be immediately available in the response. Instead, # a long running operation object is returned. User can poll the operation # result via GetOperation - # method. Once the operation is done, {Google::Cloud::AutoML::V1beta1::BatchPredictResult BatchPredictResult} is returned in - # the {Google::Longrunning::Operation#response response} field. + # method. Once the operation is done, {::Google::Cloud::AutoML::V1beta1::BatchPredictResult BatchPredictResult} is returned in + # the {::Google::Longrunning::Operation#response response} field. # Available for following ML problems: # * Image Classification # * Image Object Detection # * Video Classification # * Video Object Tracking * Text Extraction # * Tables # # @overload batch_predict(request, options = nil) # Pass arguments to `batch_predict` via a request object, either of type - # {Google::Cloud::AutoML::V1beta1::BatchPredictRequest} or an equivalent Hash. + # {::Google::Cloud::AutoML::V1beta1::BatchPredictRequest} or an equivalent Hash. # - # @param request [Google::Cloud::AutoML::V1beta1::BatchPredictRequest, Hash] + # @param request [::Google::Cloud::AutoML::V1beta1::BatchPredictRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [Gapic::CallOptions, Hash] + # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload batch_predict(name: nil, input_config: nil, output_config: nil, params: nil) # Pass arguments to `batch_predict` 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). # - # @param name [String] + # @param name [::String] # Required. Name of the model requested to serve the batch prediction. - # @param input_config [Google::Cloud::AutoML::V1beta1::BatchPredictInputConfig, Hash] + # @param input_config [::Google::Cloud::AutoML::V1beta1::BatchPredictInputConfig, ::Hash] # Required. The input configuration for batch prediction. - # @param output_config [Google::Cloud::AutoML::V1beta1::BatchPredictOutputConfig, Hash] + # @param output_config [::Google::Cloud::AutoML::V1beta1::BatchPredictOutputConfig, ::Hash] # Required. The Configuration specifying where output predictions should # be written. - # @param params [Hash{String => String}] + # @param params [::Hash{::String => ::String}] # Required. Additional domain-specific parameters for the predictions, any string must # be up to 25000 characters long. # # * For Text Classification: # @@ -377,30 +377,30 @@ # `min_bounding_box_size` - (float) Only bounding boxes with shortest edge # at least that long as a relative value of video frame size will be # returned. Value in 0 to 1 range. Default is 0. # # @yield [response, operation] Access the result along with the RPC operation - # @yieldparam response [Gapic::Operation] - # @yieldparam operation [GRPC::ActiveCall::Operation] + # @yieldparam response [::Gapic::Operation] + # @yieldparam operation [::GRPC::ActiveCall::Operation] # - # @return [Gapic::Operation] + # @return [::Gapic::Operation] # - # @raise [Google::Cloud::Error] if the RPC is aborted. + # @raise [::Google::Cloud::Error] if the RPC is aborted. # def batch_predict request, options = nil - raise ArgumentError, "request must be provided" if request.nil? + raise ::ArgumentError, "request must be provided" if request.nil? - request = Gapic::Protobuf.coerce request, to: Google::Cloud::AutoML::V1beta1::BatchPredictRequest + request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::BatchPredictRequest # Converts hash and nil to an options object - options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.batch_predict.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers - metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ + metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Automl::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { @@ -414,52 +414,52 @@ retry_policy: @config.rpcs.batch_predict.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @prediction_service_stub.call_rpc :batch_predict, request, options: options do |response, operation| - response = Gapic::Operation.new response, @operations_client, options: options + response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end - rescue GRPC::BadStatus => e - raise Google::Cloud::Error.from_error(e) + rescue ::GRPC::BadStatus => e + raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the PredictionService API. # # This class represents the configuration for PredictionService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See - # {Google::Cloud::AutoML::V1beta1::PredictionService::Client::Configuration::Rpcs} + # {::Google::Cloud::AutoML::V1beta1::PredictionService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # 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 predict # to 20 seconds, and all remaining timeouts to 10 seconds: # - # Google::Cloud::AutoML::V1beta1::PredictionService::Client.configure do |config| - # config.timeout = 10_000 - # config.rpcs.predict.timeout = 20_000 + # ::Google::Cloud::AutoML::V1beta1::PredictionService::Client.configure do |config| + # config.timeout = 10.0 + # config.rpcs.predict.timeout = 20.0 # end # # To apply the above configuration only to a new client: # - # client = Google::Cloud::AutoML::V1beta1::PredictionService::Client.new do |config| - # config.timeout = 10_000 - # config.rpcs.predict.timeout = 20_000 + # client = ::Google::Cloud::AutoML::V1beta1::PredictionService::Client.new do |config| + # config.timeout = 10.0 + # config.rpcs.predict.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"automl.googleapis.com"`. - # @return [String] + # @return [::String] # @!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 # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object @@ -467,59 +467,59 @@ # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials - # @return [Object] + # @return [::Object] # @!attribute [rw] scope # The OAuth scopes - # @return [Array<String>] + # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging - # @return [String] + # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging - # @return [String] + # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. - # @return [Hash] + # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. - # @return [Array<GRPC::ClientInterceptor>] + # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout - # The call timeout in milliseconds. - # @return [Numeric] + # The call timeout in seconds. + # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. - # @return [Hash{Symbol=>String}] + # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. - # @return [Hash] + # @return [::Hash] # class Configuration - extend Gapic::Config + extend ::Gapic::Config config_attr :endpoint, "automl.googleapis.com", String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end - config_attr :scope, nil, String, Array, nil - config_attr :lib_name, nil, String, nil - config_attr :lib_version, nil, String, nil - config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, Hash, nil) - config_attr :interceptors, nil, Array, nil - config_attr :timeout, nil, Numeric, nil - config_attr :metadata, nil, Hash, nil - config_attr :retry_policy, nil, Hash, Proc, nil + config_attr :scope, nil, ::String, ::Array, nil + config_attr :lib_name, nil, ::String, nil + config_attr :lib_version, nil, ::String, nil + config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil) + config_attr :interceptors, nil, ::Array, nil + config_attr :timeout, nil, ::Numeric, nil + config_attr :metadata, nil, ::Hash, nil + config_attr :retry_policy, nil, ::Hash, Proc, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? @@ -556,24 +556,24 @@ # trigger a retry. # class Rpcs ## # RPC-specific configuration for `predict` - # @return [Gapic::Config::Method] + # @return [::Gapic::Config::Method] # attr_reader :predict ## # RPC-specific configuration for `batch_predict` - # @return [Gapic::Config::Method] + # @return [::Gapic::Config::Method] # attr_reader :batch_predict # @private def initialize parent_rpcs = nil predict_config = parent_rpcs&.predict if parent_rpcs&.respond_to? :predict - @predict = Gapic::Config::Method.new predict_config + @predict = ::Gapic::Config::Method.new predict_config batch_predict_config = parent_rpcs&.batch_predict if parent_rpcs&.respond_to? :batch_predict - @batch_predict = Gapic::Config::Method.new batch_predict_config + @batch_predict = ::Gapic::Config::Method.new batch_predict_config yield self if block_given? end end end