google-cloud-profiler-v2 0.3.0 → 0.10.1

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

@@ -30,11 +30,18 @@ module Google
           # Manage the collection of continuous profiling data provided by profiling
           # agents running in the cloud or by an offline provider of profiling data.
           #
-          # General guidelines:
-          # * Profiles for a single deployment must be created in ascending time order.
-          # * Profiles can be created in either online or offline mode, see below.
+          # __The APIs listed in this service are intended for use within our profiler
+          # agents only.__
           #
           class Client
+            # @private
+            API_VERSION = ""
+
+            # @private
+            DEFAULT_ENDPOINT_TEMPLATE = "cloudprofiler.$UNIVERSE_DOMAIN$"
+
+            include Paths
+
             # @private
             attr_reader :profiler_service_stub
 
@@ -67,12 +74,12 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
-                default_config.timeout = 30.0
+                default_config.timeout = 60.0
                 default_config.retry_policy = {
                   initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
                 }
 
-                default_config.rpcs.create_profile.timeout = 3600.0
+                default_config.rpcs.create_profile.timeout = 3610.0
 
                 default_config.rpcs.create_offline_profile.timeout = 30.0
 
@@ -104,6 +111,15 @@ module Google
               @config
             end
 
+            ##
+            # The effective universe domain
+            #
+            # @return [String]
+            #
+            def universe_domain
+              @profiler_service_stub.universe_domain
+            end
+
             ##
             # Create a new ProfilerService client object.
             #
@@ -137,8 +153,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 == Client.configure.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)
@@ -149,10 +166,13 @@ module Google
 
               @profiler_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Profiler::V2::ProfilerService::Stub,
-                credentials:  credentials,
-                endpoint:     @config.endpoint,
+                credentials: credentials,
+                endpoint: @config.endpoint,
+                endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -161,6 +181,11 @@ module Google
             ##
             # CreateProfile creates a new profile resource in the online mode.
             #
+            # _Direct use of this API is discouraged, please use a [supported
+            # profiler
+            # agent](https://cloud.google.com/profiler/docs/about-profiler#profiling_agent)
+            # instead for profile collection._
+            #
             # The server ensures that the new profiles are created at a constant rate per
             # deployment, so the creation request may hang for some time until the next
             # profile session is available.
@@ -229,10 +254,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.create_profile.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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::Profiler::V2::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -260,9 +286,14 @@ module Google
             end
 
             ##
-            # CreateOfflineProfile creates a new profile resource in the offline mode.
-            # The client provides the profile to create along with the profile bytes, the
-            # server records it.
+            # CreateOfflineProfile creates a new profile resource in the offline
+            # mode. The client provides the profile to create along with the profile
+            # bytes, the server records it.
+            #
+            # _Direct use of this API is discouraged, please use a [supported
+            # profiler
+            # agent](https://cloud.google.com/profiler/docs/about-profiler#profiling_agent)
+            # instead for profile collection._
             #
             # @overload create_offline_profile(request, options = nil)
             #   Pass arguments to `create_offline_profile` via a request object, either of type
@@ -318,10 +349,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.create_offline_profile.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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::Profiler::V2::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -354,6 +386,11 @@ module Google
             # offline mode is currently not supported: the profile content must be
             # provided at the time of the profile creation.
             #
+            # _Direct use of this API is discouraged, please use a [supported
+            # profiler
+            # agent](https://cloud.google.com/profiler/docs/about-profiler#profiling_agent)
+            # instead for profile collection._
+            #
             # @overload update_profile(request, options = nil)
             #   Pass arguments to `update_profile` via a request object, either of type
             #   {::Google::Cloud::Profiler::V2::UpdateProfileRequest} or an equivalent Hash.
@@ -370,7 +407,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param profile [::Google::Cloud::Profiler::V2::Profile, ::Hash]
-            #     Profile to update
+            #     Profile to update.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Field mask used to specify the fields to be overwritten. Currently only
             #     profile_bytes and labels fields are supported by UpdateProfile, so only
@@ -411,10 +448,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.update_profile.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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::Profiler::V2::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -471,17 +509,17 @@ module Google
             #   end
             #
             # @!attribute [rw] endpoint
-            #   The hostname or hostname:port of the service endpoint.
-            #   Defaults to `"cloudprofiler.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
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
@@ -519,11 +557,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
 
-              config_attr :endpoint,      "cloudprofiler.googleapis.com", ::String
+              # @private
+              # The endpoint specific to the default "googleapis.com" universe. Deprecated.
+              DEFAULT_ENDPOINT = "cloudprofiler.googleapis.com"
+
+              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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -538,6 +585,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
@@ -558,6 +606,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the ProfilerService API.
               #

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+
+module Google
+  module Cloud
+    module Profiler
+      module V2
+        module ProfilerService
+          # Path helper methods for the ProfilerService API.
+          module Paths
+            ##
+            # Create a fully-qualified Profile resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/profiles/{profile}`
+            #
+            # @param project [String]
+            # @param profile [String]
+            #
+            # @return [::String]
+            def profile_path project:, profile:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/profiles/#{profile}"
+            end
+
+            ##
+            # Create a fully-qualified Project resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}`
+            #
+            # @param project [String]
+            #
+            # @return [::String]
+            def project_path project:
+              "projects/#{project}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end