google-cloud-debugger 0.24.0

data/lib/google/cloud/debugger/v2/controller2_client_config.json

@@ -0,0 +1,43 @@
+{
+  "interfaces": {
+    "google.devtools.clouddebugger.v2.Controller2": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": [
+          "UNAVAILABLE"
+        ]
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 60000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 60000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "RegisterDebuggee": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "ListActiveBreakpoints": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateActiveBreakpoint": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/cloud/debugger/v2/debugger2_client.rb

@@ -0,0 +1,378 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/devtools/clouddebugger/v2/debugger.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+#
+# The only allowed edits are to method and file documentation. A 3-way
+# merge preserves those additions if the generated source changes.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+
+require "google/devtools/clouddebugger/v2/debugger_pb"
+
+module Google
+  module Cloud
+    module Debugger
+      module V2
+        # The Debugger service provides the API that allows users to collect run-time
+        # information from a running application, without stopping or slowing it down
+        # and without modifying its state.  An application may include one or
+        # more replicated processes performing the same work.
+        #
+        # The application is represented using the Debuggee concept. The Debugger
+        # service provides a way to query for available Debuggees, but does not
+        # provide a way to create one.  A debuggee is created using the Controller
+        # service, usually by running a debugger agent with the application.
+        #
+        # The Debugger service enables the client to set one or more Breakpoints on a
+        # Debuggee and collect the results of the set Breakpoints.
+        #
+        # @!attribute [r] debugger2_stub
+        #   @return [Google::Devtools::Clouddebugger::V2::Debugger2::Stub]
+        class Debugger2Client
+          attr_reader :debugger2_stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "clouddebugger.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          DEFAULT_TIMEOUT = 30
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_SCOPES = [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/cloud_debugger"
+          ].freeze
+
+          # @param service_path [String]
+          #   The domain name of the API remote host.
+          # @param port [Integer]
+          #   The port on which to connect to the remote host.
+          # @param channel [Channel]
+          #   A Channel object through which to make calls.
+          # @param chan_creds [Grpc::ChannelCredentials]
+          #   A ChannelCredentials for the setting up the RPC client.
+          # @param client_config[Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          def initialize \
+              service_path: SERVICE_ADDRESS,
+              port: DEFAULT_SERVICE_PORT,
+              channel: nil,
+              chan_creds: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              app_name: nil,
+              app_version: nil,
+              lib_name: nil,
+              lib_version: ""
+            # These require statements are intentionally placed here to initialize
+            # the gRPC module only when it's required.
+            # See https://github.com/googleapis/toolkit/issues/446
+            require "google/gax/grpc"
+            require "google/devtools/clouddebugger/v2/debugger_services_pb"
+
+
+            if app_name || app_version
+              warn "`app_name` and `app_version` are no longer being used in the request headers."
+            end
+
+            google_api_client = "gl-ruby/#{RUBY_VERSION}"
+            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+            google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
+            google_api_client << " grpc/#{GRPC::VERSION}"
+            google_api_client.freeze
+
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "debugger2_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.devtools.clouddebugger.v2.Debugger2",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+            @debugger2_stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              scopes: scopes,
+              &Google::Devtools::Clouddebugger::V2::Debugger2::Stub.method(:new)
+            )
+
+            @set_breakpoint = Google::Gax.create_api_call(
+              @debugger2_stub.method(:set_breakpoint),
+              defaults["set_breakpoint"]
+            )
+            @get_breakpoint = Google::Gax.create_api_call(
+              @debugger2_stub.method(:get_breakpoint),
+              defaults["get_breakpoint"]
+            )
+            @delete_breakpoint = Google::Gax.create_api_call(
+              @debugger2_stub.method(:delete_breakpoint),
+              defaults["delete_breakpoint"]
+            )
+            @list_breakpoints = Google::Gax.create_api_call(
+              @debugger2_stub.method(:list_breakpoints),
+              defaults["list_breakpoints"]
+            )
+            @list_debuggees = Google::Gax.create_api_call(
+              @debugger2_stub.method(:list_debuggees),
+              defaults["list_debuggees"]
+            )
+          end
+
+          # Service calls
+
+          # Sets the breakpoint to the debuggee.
+          #
+          # @param debuggee_id [String]
+          #   ID of the debuggee where the breakpoint is to be set.
+          # @param breakpoint [Google::Devtools::Clouddebugger::V2::Breakpoint]
+          #   Breakpoint specification to set.
+          #   The field 'location' of the breakpoint must be set.
+          # @param client_version [String]
+          #   The client version making the call.
+          #   Following: +domain/type/version+ (e.g., +google.com/intellij/v1+).
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Devtools::Clouddebugger::V2::SetBreakpointResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/debugger/v2/debugger2_client"
+          #
+          #   Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
+          #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
+          #
+          #   debugger2_client = Debugger2Client.new
+          #   debuggee_id = ''
+          #   breakpoint = Breakpoint.new
+          #   client_version = ''
+          #   response = debugger2_client.set_breakpoint(debuggee_id, breakpoint, client_version)
+
+          def set_breakpoint \
+              debuggee_id,
+              breakpoint,
+              client_version,
+              options: nil
+            req = Google::Devtools::Clouddebugger::V2::SetBreakpointRequest.new({
+              debuggee_id: debuggee_id,
+              breakpoint: breakpoint,
+              client_version: client_version
+            }.delete_if { |_, v| v.nil? })
+            @set_breakpoint.call(req, options)
+          end
+
+          # Gets breakpoint information.
+          #
+          # @param debuggee_id [String]
+          #   ID of the debuggee whose breakpoint to get.
+          # @param breakpoint_id [String]
+          #   ID of the breakpoint to get.
+          # @param client_version [String]
+          #   The client version making the call.
+          #   Following: +domain/type/version+ (e.g., +google.com/intellij/v1+).
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Devtools::Clouddebugger::V2::GetBreakpointResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/debugger/v2/debugger2_client"
+          #
+          #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
+          #
+          #   debugger2_client = Debugger2Client.new
+          #   debuggee_id = ''
+          #   breakpoint_id = ''
+          #   client_version = ''
+          #   response = debugger2_client.get_breakpoint(debuggee_id, breakpoint_id, client_version)
+
+          def get_breakpoint \
+              debuggee_id,
+              breakpoint_id,
+              client_version,
+              options: nil
+            req = Google::Devtools::Clouddebugger::V2::GetBreakpointRequest.new({
+              debuggee_id: debuggee_id,
+              breakpoint_id: breakpoint_id,
+              client_version: client_version
+            }.delete_if { |_, v| v.nil? })
+            @get_breakpoint.call(req, options)
+          end
+
+          # Deletes the breakpoint from the debuggee.
+          #
+          # @param debuggee_id [String]
+          #   ID of the debuggee whose breakpoint to delete.
+          # @param breakpoint_id [String]
+          #   ID of the breakpoint to delete.
+          # @param client_version [String]
+          #   The client version making the call.
+          #   Following: +domain/type/version+ (e.g., +google.com/intellij/v1+).
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/debugger/v2/debugger2_client"
+          #
+          #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
+          #
+          #   debugger2_client = Debugger2Client.new
+          #   debuggee_id = ''
+          #   breakpoint_id = ''
+          #   client_version = ''
+          #   debugger2_client.delete_breakpoint(debuggee_id, breakpoint_id, client_version)
+
+          def delete_breakpoint \
+              debuggee_id,
+              breakpoint_id,
+              client_version,
+              options: nil
+            req = Google::Devtools::Clouddebugger::V2::DeleteBreakpointRequest.new({
+              debuggee_id: debuggee_id,
+              breakpoint_id: breakpoint_id,
+              client_version: client_version
+            }.delete_if { |_, v| v.nil? })
+            @delete_breakpoint.call(req, options)
+            nil
+          end
+
+          # Lists all breakpoints for the debuggee.
+          #
+          # @param debuggee_id [String]
+          #   ID of the debuggee whose breakpoints to list.
+          # @param client_version [String]
+          #   The client version making the call.
+          #   Following: +domain/type/version+ (e.g., +google.com/intellij/v1+).
+          # @param include_all_users [true, false]
+          #   When set to +true+, the response includes the list of breakpoints set by
+          #   any user. Otherwise, it includes only breakpoints set by the caller.
+          # @param include_inactive [true, false]
+          #   When set to +true+, the response includes active and inactive
+          #   breakpoints. Otherwise, it includes only active breakpoints.
+          # @param action [Google::Devtools::Clouddebugger::V2::ListBreakpointsRequest::BreakpointActionValue]
+          #   When set, the response includes only breakpoints with the specified action.
+          # @param strip_results [true, false]
+          #   This field is deprecated. The following fields are always stripped out of
+          #   the result: +stack_frames+, +evaluated_expressions+ and +variable_table+.
+          # @param wait_token [String]
+          #   A wait token that, if specified, blocks the call until the breakpoints
+          #   list has changed, or a server selected timeout has expired.  The value
+          #   should be set from the last response. The error code
+          #   +google.rpc.Code.ABORTED+ (RPC) is returned on wait timeout, which
+          #   should be called again with the same +wait_token+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Devtools::Clouddebugger::V2::ListBreakpointsResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/debugger/v2/debugger2_client"
+          #
+          #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
+          #
+          #   debugger2_client = Debugger2Client.new
+          #   debuggee_id = ''
+          #   client_version = ''
+          #   response = debugger2_client.list_breakpoints(debuggee_id, client_version)
+
+          def list_breakpoints \
+              debuggee_id,
+              client_version,
+              include_all_users: nil,
+              include_inactive: nil,
+              action: nil,
+              strip_results: nil,
+              wait_token: nil,
+              options: nil
+            req = Google::Devtools::Clouddebugger::V2::ListBreakpointsRequest.new({
+              debuggee_id: debuggee_id,
+              client_version: client_version,
+              include_all_users: include_all_users,
+              include_inactive: include_inactive,
+              action: action,
+              strip_results: strip_results,
+              wait_token: wait_token
+            }.delete_if { |_, v| v.nil? })
+            @list_breakpoints.call(req, options)
+          end
+
+          # Lists all the debuggees that the user can set breakpoints to.
+          #
+          # @param project [String]
+          #   Project number of a Google Cloud project whose debuggees to list.
+          # @param client_version [String]
+          #   The client version making the call.
+          #   Following: +domain/type/version+ (e.g., +google.com/intellij/v1+).
+          # @param include_inactive [true, false]
+          #   When set to +true+, the result includes all debuggees. Otherwise, the
+          #   result includes only debuggees that are active.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Devtools::Clouddebugger::V2::ListDebuggeesResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/debugger/v2/debugger2_client"
+          #
+          #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
+          #
+          #   debugger2_client = Debugger2Client.new
+          #   project = ''
+          #   client_version = ''
+          #   response = debugger2_client.list_debuggees(project, client_version)
+
+          def list_debuggees \
+              project,
+              client_version,
+              include_inactive: nil,
+              options: nil
+            req = Google::Devtools::Clouddebugger::V2::ListDebuggeesRequest.new({
+              project: project,
+              client_version: client_version,
+              include_inactive: include_inactive
+            }.delete_if { |_, v| v.nil? })
+            @list_debuggees.call(req, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/debugger/v2/debugger2_client_config.json

@@ -0,0 +1,53 @@
+{
+  "interfaces": {
+    "google.devtools.clouddebugger.v2.Debugger2": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": [
+          "UNAVAILABLE"
+        ]
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 60000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 60000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "SetBreakpoint": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "GetBreakpoint": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteBreakpoint": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "ListBreakpoints": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "ListDebuggees": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}