google-cloud-profiler-v2 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87d61aaaac77ee8c2fcf373c53e558d795879a2e25c803b187bef92063fdbb2e
-  data.tar.gz: 47f6364c2d03a4fa1181a2841f4af1c7e7ce5c0b4524a756389e4f1b75b2ab8c
+  metadata.gz: bb2ad911ae1c5a74aadb4a0c7cb401ad67201f588d82a912151d135d5dc684c9
+  data.tar.gz: 51624476eb148b86c06fa97b7ba52ea57b35ad5f5ec98e7f23d6fb08f4e89fb0
 SHA512:
-  metadata.gz: e9eee42ce876fa71731f52c5d5fbeefba22ad12c9bdaad0bcc325818c8d3756b27ca92306617b9257c05c33a61843563bfc2917bda713aff1629475eee713902
-  data.tar.gz: b2dcf13e00b8ee75c72816ab941a80d8c636caa63267d2826406a60c415ab8732e83470e149fa457697f251d8f1da347973340189ce4fa1abbef5043b74cfc50
+  metadata.gz: 0c5b403a13e55c3587bf87b744fb42bc3bfd225bb7207964137707ce468831dda1b6517bd7538639189ab63a9cd1435f7ed387602af845e63001de63178fbb52
+  data.tar.gz: fa44484a64a9069c7e2016b97e20861d863f33091fff5f80bfa050dd19da572b9e22f7fcbf9f1d25b20b59a874dbb831146b3940302126ba6e13ad76d5f40272

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-profiler-v2
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Profiler::V2::ProfilerService::Credentials}):
 
-1. `PROFILER_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `PROFILER_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `PROFILER_CREDENTIALS` - Path to JSON file, or JSON contents
+* `PROFILER_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/profiler/v2"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/profiler/v2"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/profiler/v2"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/profiler/v2"
 
 client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new
-request = my_create_request
+request = ::Google::Cloud::Profiler::V2::CreateProfileRequest.new # (request fields as keyword arguments...)
 response = client.create_profile request
 ```
 

data/lib/google/cloud/profiler/v2/profiler_service/client.rb

@@ -44,13 +44,12 @@ module Google
             # See {::Google::Cloud::Profiler::V2::ProfilerService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all ProfilerService clients:
-            #
-            #     ::Google::Cloud::Profiler::V2::ProfilerService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all ProfilerService clients
+            #   ::Google::Cloud::Profiler::V2::ProfilerService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -70,10 +69,7 @@ module Google
 
                 default_config.timeout = 30.0
                 default_config.retry_policy = {
-                  initial_delay: 1.0,
-                max_delay: 10.0,
-                multiplier: 1.3,
-                retry_codes: [14]
+                  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.create_profile.timeout = 3600.0
@@ -111,19 +107,15 @@ module Google
             ##
             # Create a new ProfilerService client object.
             #
-            # ## Examples
-            #
-            # To create a new ProfilerService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new
             #
-            # To create a new ProfilerService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the ProfilerService client.
             # @yieldparam config [Client::Configuration]
@@ -143,14 +135,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -212,6 +203,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/profiler/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Profiler::V2::ProfilerService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Profiler::V2::CreateProfileRequest.new
+            #
+            #   # Call the create_profile method.
+            #   result = client.create_profile request
+            #
+            #   # The returned object is of type Google::Cloud::Profiler::V2::Profile.
+            #   p result
+            #
             def create_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -229,16 +235,20 @@ module Google
                 gapic_version: ::Google::Cloud::Profiler::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.create_profile.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_profile.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @profiler_service_stub.call_rpc :create_profile, request, options: options do |response, operation|
@@ -282,6 +292,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/profiler/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Profiler::V2::ProfilerService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Profiler::V2::CreateOfflineProfileRequest.new
+            #
+            #   # Call the create_offline_profile method.
+            #   result = client.create_offline_profile request
+            #
+            #   # The returned object is of type Google::Cloud::Profiler::V2::Profile.
+            #   p result
+            #
             def create_offline_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -299,16 +324,20 @@ module Google
                 gapic_version: ::Google::Cloud::Profiler::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.create_offline_profile.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_offline_profile.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @profiler_service_stub.call_rpc :create_offline_profile, request, options: options do |response, operation|
@@ -356,6 +385,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/profiler/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Profiler::V2::ProfilerService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Profiler::V2::UpdateProfileRequest.new
+            #
+            #   # Call the update_profile method.
+            #   result = client.update_profile request
+            #
+            #   # The returned object is of type Google::Cloud::Profiler::V2::Profile.
+            #   p result
+            #
             def update_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -373,16 +417,20 @@ module Google
                 gapic_version: ::Google::Cloud::Profiler::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "profile.name" => request.profile.name
-              }
+              header_params = {}
+              if request.profile&.name
+                header_params["profile.name"] = request.profile.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.update_profile.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_profile.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @profiler_service_stub.call_rpc :update_profile, request, options: options do |response, operation|
@@ -406,22 +454,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for create_profile
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Profiler::V2::ProfilerService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_profile.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_profile.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # create_profile to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Profiler::V2::ProfilerService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_profile.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_profile.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/profiler/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Profiler
       module V2
-        VERSION = "0.2.0"
+        VERSION = "0.2.4"
       end
     end
   end

data/lib/google/devtools/cloudprofiler/v2/profiler_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/cloudprofiler/v2/profiler.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/api/client_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/devtools/cloudprofiler/v2/profiler.proto", :syntax => :proto3) do
     add_message "google.devtools.cloudprofiler.v2.CreateProfileRequest" do

data/lib/google/devtools/cloudprofiler/v2/profiler_services_pb.rb

@@ -32,7 +32,7 @@ module Google
           # * Profiles can be created in either online or offline mode, see below.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-profiler-v2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Profiler V2 API