class Google::Cloud::Debugger::V2::Debugger::Client

Client for the Debugger service.

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.

A debugged 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.

Attributes

debugger_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Debugger Client class.

See {::Google::Cloud::Debugger::V2::Debugger::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Debugger clients
::Google::Cloud::Debugger::V2::Debugger::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 65
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Debugger", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.set_breakpoint.timeout = 600.0

    default_config.rpcs.get_breakpoint.timeout = 600.0
    default_config.rpcs.get_breakpoint.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_breakpoint.timeout = 600.0
    default_config.rpcs.delete_breakpoint.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_breakpoints.timeout = 600.0
    default_config.rpcs.list_breakpoints.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_debuggees.timeout = 600.0
    default_config.rpcs.list_debuggees.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Debugger client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Debugger::V2::Debugger::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Debugger::V2::Debugger::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Debugger client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 140
def initialize
  # 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 "gapic/grpc"
  require "google/devtools/clouddebugger/v2/debugger_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  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?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @debugger_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Debugger::V2::Debugger2::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the Debugger Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Cloud::Debugger::V2::Debugger::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 119
def configure
  yield @config if block_given?
  @config
end
delete_breakpoint(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the breakpoint from the debuggee.

@overload delete_breakpoint(request, options = nil)

Pass arguments to `delete_breakpoint` via a request object, either of type
{::Google::Cloud::Debugger::V2::DeleteBreakpointRequest} or an equivalent Hash.

@param request [::Google::Cloud::Debugger::V2::DeleteBreakpointRequest, ::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 delete_breakpoint(debuggee_id: nil, breakpoint_id: nil, client_version: nil)

Pass arguments to `delete_breakpoint` 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 debuggee_id [::String]
  Required. ID of the debuggee whose breakpoint to delete.
@param breakpoint_id [::String]
  Required. ID of the breakpoint to delete.
@param client_version [::String]
  Required. The client version making the call.
  Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 360
def delete_breakpoint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::DeleteBreakpointRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_breakpoint.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "debuggee_id" => request.debuggee_id,
    "breakpoint_id" => request.breakpoint_id
  }
  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.delete_breakpoint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_breakpoint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @debugger_stub.call_rpc :delete_breakpoint, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_breakpoint(request, options = nil) { |response, operation| ... } click to toggle source

Gets breakpoint information.

@overload get_breakpoint(request, options = nil)

Pass arguments to `get_breakpoint` via a request object, either of type
{::Google::Cloud::Debugger::V2::GetBreakpointRequest} or an equivalent Hash.

@param request [::Google::Cloud::Debugger::V2::GetBreakpointRequest, ::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_breakpoint(debuggee_id: nil, breakpoint_id: nil, client_version: nil)

Pass arguments to `get_breakpoint` 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 debuggee_id [::String]
  Required. ID of the debuggee whose breakpoint to get.
@param breakpoint_id [::String]
  Required. ID of the breakpoint to get.
@param client_version [::String]
  Required. The client version making the call.
  Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Debugger::V2::GetBreakpointResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Debugger::V2::GetBreakpointResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 286
def get_breakpoint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::GetBreakpointRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_breakpoint.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "debuggee_id" => request.debuggee_id,
    "breakpoint_id" => request.breakpoint_id
  }
  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.get_breakpoint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_breakpoint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @debugger_stub.call_rpc :get_breakpoint, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_breakpoints(request, options = nil) { |response, operation| ... } click to toggle source

Lists all breakpoints for the debuggee.

@overload list_breakpoints(request, options = nil)

Pass arguments to `list_breakpoints` via a request object, either of type
{::Google::Cloud::Debugger::V2::ListBreakpointsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Debugger::V2::ListBreakpointsRequest, ::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_breakpoints(debuggee_id: nil, include_all_users: nil, include_inactive: nil, action: nil, strip_results: nil, wait_token: nil, client_version: nil)

Pass arguments to `list_breakpoints` 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 debuggee_id [::String]
  Required. ID of the debuggee whose breakpoints to list.
@param include_all_users [::Boolean]
  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 [::Boolean]
  When set to `true`, the response includes active and inactive
  breakpoints. Otherwise, it includes only active breakpoints.
@param action [::Google::Cloud::Debugger::V2::ListBreakpointsRequest::BreakpointActionValue, ::Hash]
  When set, the response includes only breakpoints with the specified action.
@param strip_results [::Boolean]
  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 client_version [::String]
  Required. The client version making the call.
  Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Debugger::V2::ListBreakpointsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Debugger::V2::ListBreakpointsResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 449
def list_breakpoints request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::ListBreakpointsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_breakpoints.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "debuggee_id" => request.debuggee_id
  }
  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.list_breakpoints.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_breakpoints.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @debugger_stub.call_rpc :list_breakpoints, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_debuggees(request, options = nil) { |response, operation| ... } click to toggle source

Lists all the debuggees that the user has access to.

@overload list_debuggees(request, options = nil)

Pass arguments to `list_debuggees` via a request object, either of type
{::Google::Cloud::Debugger::V2::ListDebuggeesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Debugger::V2::ListDebuggeesRequest, ::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_debuggees(project: nil, include_inactive: nil, client_version: nil)

Pass arguments to `list_debuggees` 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 project [::String]
  Required. Project number of a Google Cloud project whose debuggees to list.
@param include_inactive [::Boolean]
  When set to `true`, the result includes all debuggees. Otherwise, the
  result includes only debuggees that are active.
@param client_version [::String]
  Required. The client version making the call.
  Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Debugger::V2::ListDebuggeesResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Debugger::V2::ListDebuggeesResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 523
def list_debuggees request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::ListDebuggeesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_debuggees.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_debuggees.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_debuggees.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @debugger_stub.call_rpc :list_debuggees, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
set_breakpoint(request, options = nil) { |response, operation| ... } click to toggle source

Sets the breakpoint to the debuggee.

@overload set_breakpoint(request, options = nil)

Pass arguments to `set_breakpoint` via a request object, either of type
{::Google::Cloud::Debugger::V2::SetBreakpointRequest} or an equivalent Hash.

@param request [::Google::Cloud::Debugger::V2::SetBreakpointRequest, ::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 set_breakpoint(debuggee_id: nil, breakpoint: nil, client_version: nil)

Pass arguments to `set_breakpoint` 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 debuggee_id [::String]
  Required. ID of the debuggee where the breakpoint is to be set.
@param breakpoint [::Google::Cloud::Debugger::V2::Breakpoint, ::Hash]
  Required. Breakpoint specification to set.
  The field `location` of the breakpoint must be set.
@param client_version [::String]
  Required. The client version making the call.
  Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Debugger::V2::SetBreakpointResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Debugger::V2::SetBreakpointResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/debugger/v2/debugger/client.rb, line 213
def set_breakpoint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::SetBreakpointRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_breakpoint.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "debuggee_id" => request.debuggee_id
  }
  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.set_breakpoint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_breakpoint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @debugger_stub.call_rpc :set_breakpoint, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end