google-cloud-recommender-v1 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b854a911691f57d45c304c4d4bf74de62eb83a70d1c252eda9250f244f558f88
-  data.tar.gz: fb0efe36c11e2aae0434710ae36b1d20aaaea6df823b243578147edbe0b0685d
+  metadata.gz: 731ed6c78c054da3bbdf1cc6b41bb469fab9af92b5293940871863ab10240557
+  data.tar.gz: 28f51bb11efe1aafd3f7f83282c47d891b7e14425b0375be7e86cdddc2f2e46a
 SHA512:
-  metadata.gz: e15d154a646a9676d3335c7f1029469d51d3ebd27e654179dbd686dab57f9aca70d6559f71c3bd0a2225c9ac9a46286b8aed8a76179c4d3b744287fb1f2fb16e
-  data.tar.gz: 3191ab85ba008bbc482030e491535c3051859a7b10fb897d2caf701c7be648fa28ccda4930a92801b4e9a6c154f8f19aaa47a800b14baeccfa0cfd46407d00af
+  metadata.gz: 72dedccefbda969920ad42bdacba992825abfd3ab02b1e81fa15e29ae131226fe242cf2deb5624ce302b895f788209abeb89ec911a8c9a22099953652e884ed4
+  data.tar.gz: 1d2bf1dcdff912fe365b5ec3aabe2d6a24cbffec9c56f6903c8c3cc9e25f7c847ac23e30d43c571485abc2a8c71d44e9ea56833c7bf6dde12084af9302b97766

data/README.md

@@ -1,4 +1,4 @@
-# Recommender V1
+# Ruby Client for the Recommender V1 API
 
 API Client library for the Recommender V1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-recommender-v1
 ```
 
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/recommender/v1"
+
+client = Google::Cloud::Recommender::V1::Recommender::Client.new
+request = my_create_request
+response = client.list_recommendations request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-recommender-v1/latest)
+for class and method documentation.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

data/lib/google-cloud-recommender-v1.rb

@@ -1 +1,21 @@
-require "google/cloud/recommender/v1/version"
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/recommender/v1"

data/lib/google/cloud/recommender/v1.rb

@@ -17,3 +17,19 @@
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
 require "google/cloud/recommender/v1/recommender"
+require "google/cloud/recommender/v1/version"
+
+module Google
+  module Cloud
+    module Recommender
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/recommender/v1"
+      #     client = Google::Cloud::Recommender::V1::Recommender::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

data/lib/google/cloud/recommender/v1/recommender.rb

@@ -16,5 +16,37 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/recommender/v1/recommender/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/recommender/v1/version"
+
 require "google/cloud/recommender/v1/recommender/credentials"
+require "google/cloud/recommender/v1/recommender/paths"
+require "google/cloud/recommender/v1/recommender/client"
+
+module Google
+  module Cloud
+    module Recommender
+      module V1
+        ##
+        # Provides recommendations for cloud customers for various categories like
+        # performance optimization, cost savings, reliability, feature discovery, etc.
+        # These recommendations are generated automatically based on analysis of user
+        # resources, configuration and monitoring metrics.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/recommender/v1/recommender"
+        #     client = Google::Cloud::Recommender::V1::Recommender::Client.new
+        #
+        module Recommender
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "recommender", "helpers.rb"
+require "google/cloud/recommender/v1/recommender/helpers" if ::File.file? helper_path

data/lib/google/cloud/recommender/v1/recommender/client.rb

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/recommender/v1/version"
 require "google/cloud/recommender/v1/recommender_service_pb"
-require "google/cloud/recommender/v1/recommender/credentials"
-require "google/cloud/recommender/v1/recommender/paths"
 
 module Google
   module Cloud
@@ -180,13 +173,20 @@ module Google
             # IAM permission for the specified recommender.
             #
             # @overload list_recommendations(request, options = nil)
-            #   @param request [Google::Cloud::Recommender::V1::ListRecommendationsRequest | Hash]
-            #     Lists recommendations for a Cloud project. Requires the recommender.*.list
-            #     IAM permission for the specified recommender.
+            #   Pass arguments to `list_recommendations` via a request object, either of type
+            #   {Google::Cloud::Recommender::V1::ListRecommendationsRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Recommender::V1::ListRecommendationsRequest, 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]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload list_recommendations(parent: nil, page_size: nil, page_token: nil, filter: nil)
+            #   Pass arguments to `list_recommendations` 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 parent [String]
             #     Required. The container resource on which to execute the request.
             #     Acceptable formats:
@@ -210,7 +210,6 @@ module Google
             #     filter fields: state_info.state
             #     Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Recommender::V1::Recommendation>]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -262,17 +261,23 @@ module Google
             # IAM permission for the specified recommender.
             #
             # @overload get_recommendation(request, options = nil)
-            #   @param request [Google::Cloud::Recommender::V1::GetRecommendationRequest | Hash]
-            #     Gets the requested recommendation. Requires the recommender.*.get
-            #     IAM permission for the specified recommender.
+            #   Pass arguments to `get_recommendation` via a request object, either of type
+            #   {Google::Cloud::Recommender::V1::GetRecommendationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Recommender::V1::GetRecommendationRequest, 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]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload get_recommendation(name: nil)
+            #   Pass arguments to `get_recommendation` 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]
             #     Required. Name of the recommendation.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Recommender::V1::Recommendation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -331,21 +336,20 @@ module Google
             # recommender.
             #
             # @overload mark_recommendation_claimed(request, options = nil)
-            #   @param request [Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest | Hash]
-            #     Mark the Recommendation State as Claimed. Users can use this method to
-            #     indicate to the Recommender API that they are starting to apply the
-            #     recommendation themselves. This stops the recommendation content from being
-            #     updated.
-            #
-            #     MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
-            #     SUCCEEDED, FAILED, or ACTIVE state.
+            #   Pass arguments to `mark_recommendation_claimed` via a request object, either of type
+            #   {Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest} or an equivalent Hash.
             #
-            #     Requires the recommender.*.update IAM permission for the specified
-            #     recommender.
+            #   @param request [Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest, 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]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload mark_recommendation_claimed(name: nil, state_metadata: nil, etag: nil)
+            #   Pass arguments to `mark_recommendation_claimed` 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]
             #     Required. Name of the recommendation.
             #   @param state_metadata [Hash{String => String}]
@@ -356,7 +360,6 @@ module Google
             #   @param etag [String]
             #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Recommender::V1::Recommendation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -415,21 +418,20 @@ module Google
             # recommender.
             #
             # @overload mark_recommendation_succeeded(request, options = nil)
-            #   @param request [Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest | Hash]
-            #     Mark the Recommendation State as Succeeded. Users can use this method to
-            #     indicate to the Recommender API that they have applied the recommendation
-            #     themselves, and the operation was successful. This stops the recommendation
-            #     content from being updated.
+            #   Pass arguments to `mark_recommendation_succeeded` via a request object, either of type
+            #   {Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest} or an equivalent Hash.
             #
-            #     MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,
-            #     CLAIMED, SUCCEEDED, or FAILED state.
-            #
-            #     Requires the recommender.*.update IAM permission for the specified
-            #     recommender.
+            #   @param request [Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest, 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]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload mark_recommendation_succeeded(name: nil, state_metadata: nil, etag: nil)
+            #   Pass arguments to `mark_recommendation_succeeded` 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]
             #     Required. Name of the recommendation.
             #   @param state_metadata [Hash{String => String}]
@@ -440,7 +442,6 @@ module Google
             #   @param etag [String]
             #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Recommender::V1::Recommendation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -499,21 +500,20 @@ module Google
             # recommender.
             #
             # @overload mark_recommendation_failed(request, options = nil)
-            #   @param request [Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest | Hash]
-            #     Mark the Recommendation State as Failed. Users can use this method to
-            #     indicate to the Recommender API that they have applied the recommendation
-            #     themselves, and the operation failed. This stops the recommendation content
-            #     from being updated.
+            #   Pass arguments to `mark_recommendation_failed` via a request object, either of type
+            #   {Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest} or an equivalent Hash.
             #
-            #     MarkRecommendationFailed can be applied to recommendations in ACTIVE,
-            #     CLAIMED, SUCCEEDED, or FAILED state.
-            #
-            #     Requires the recommender.*.update IAM permission for the specified
-            #     recommender.
+            #   @param request [Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest, 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]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload mark_recommendation_failed(name: nil, state_metadata: nil, etag: nil)
+            #   Pass arguments to `mark_recommendation_failed` 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]
             #     Required. Name of the recommendation.
             #   @param state_metadata [Hash{String => String}]
@@ -524,7 +524,6 @@ module Google
             #   @param etag [String]
             #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Recommender::V1::Recommendation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -751,13 +750,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/recommender/v1/recommender/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

data/lib/google/cloud/recommender/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Recommender
       module V1
-        VERSION = "0.3.1"
+        VERSION = "0.3.2"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common