google-cloud-profiler-v2 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ae6c9a3bcd800b09a1d3c7245d9857950e9ab9ae11002cabd4a52629da6583d
-  data.tar.gz: 1801b1ae65f4f64786dd5f97ed0782f4d475981efe094238e6cb12a17b925c5f
+  metadata.gz: 79883aecdcb67dda5b935b8373afc7f6be46a42710e1764dc6292f47f9e7a040
+  data.tar.gz: 2325c24a4462a4c4cd6c5dcc9be5d31cc3d3ee89bc198d19ebe705fa0776d79b
 SHA512:
-  metadata.gz: 161d0ecd080f91afacfe7ac4ea39c4d0a3e1b7463d4d5c05f51d780c0d6d62d70394ccd37ea5cb397a688edda82301f73aafbd8a9ac463625147c68fa04c80b8
-  data.tar.gz: 31ec6a43f4b3c9fed78ed6c9cef79a1c5ab8e45c60d1b23ad83405fc73ae2c78c8dc76877a600c5e4e0ae05ca1cf4a748efe4da49285df34aa5789dec354e220
+  metadata.gz: 51e1b2f7bda1d1d2c9d1ee47a7781928d35b8fd8724eb7116dbcc3707bdb58e47192a89c84da01f8e0065c33b0a7fab0d17bce1a50dbf5b050ee307f55fdc1cf
+  data.tar.gz: 9a53713132222c810c1e6ec9fdedea221e80b51bb1ca1eb297bfb57139c6d6954a625d767169615b2e28dc1bf854fd73423b5aad35b39b54e06fbe8878ae8a63

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Cloud Profiler V2 API
+--title="Cloud Profiler V2 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

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"
@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

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.1"
+        VERSION = "0.2.5"
       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/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-profiler-v2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Profiler V2 API