Class: Google::Cloud::Debugger::V2::Debugger::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/debugger/v2/debugger/client.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Debugger client object.

Examples:


# 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

Yields:

  • (config)

    Configure the Debugger client.

Yield Parameters:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# 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

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Debugger Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# 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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



119
120
121
122
# 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) ⇒ ::Google::Protobuf::Empty #delete_breakpoint(debuggee_id: nil, breakpoint_id: nil, client_version: nil) ⇒ ::Google::Protobuf::Empty

Deletes the breakpoint from the debuggee.

Overloads:

  • #delete_breakpoint(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_breakpoint(debuggee_id: nil, breakpoint_id: nil, client_version: nil) ⇒ ::Google::Protobuf::Empty

    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).

    Parameters:

    • debuggee_id (::String) (defaults to: nil)

      Required. ID of the debuggee whose breakpoint to delete.

    • breakpoint_id (::String) (defaults to: nil)

      Required. ID of the breakpoint to delete.

    • client_version (::String) (defaults to: nil)

      Required. The client version making the call. Schema: domain/type/version (e.g., google.com/intellij/v1).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# 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
   = @config.rpcs.delete_breakpoint..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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) ⇒ ::Google::Cloud::Debugger::V2::GetBreakpointResponse #get_breakpoint(debuggee_id: nil, breakpoint_id: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::GetBreakpointResponse

Gets breakpoint information.

Overloads:

  • #get_breakpoint(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::GetBreakpointResponse

    Pass arguments to get_breakpoint via a request object, either of type GetBreakpointRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_breakpoint(debuggee_id: nil, breakpoint_id: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::GetBreakpointResponse

    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).

    Parameters:

    • debuggee_id (::String) (defaults to: nil)

      Required. ID of the debuggee whose breakpoint to get.

    • breakpoint_id (::String) (defaults to: nil)

      Required. ID of the breakpoint to get.

    • client_version (::String) (defaults to: nil)

      Required. The client version making the call. Schema: domain/type/version (e.g., google.com/intellij/v1).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# 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
   = @config.rpcs.get_breakpoint..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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) ⇒ ::Google::Cloud::Debugger::V2::ListBreakpointsResponse #list_breakpoints(debuggee_id: nil, include_all_users: nil, include_inactive: nil, action: nil, strip_results: nil, wait_token: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::ListBreakpointsResponse

Lists all breakpoints for the debuggee.

Overloads:

  • #list_breakpoints(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::ListBreakpointsResponse

    Pass arguments to list_breakpoints via a request object, either of type ListBreakpointsRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_breakpoints(debuggee_id: nil, include_all_users: nil, include_inactive: nil, action: nil, strip_results: nil, wait_token: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::ListBreakpointsResponse

    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).

    Parameters:

    • debuggee_id (::String) (defaults to: nil)

      Required. ID of the debuggee whose breakpoints to list.

    • include_all_users (::Boolean) (defaults to: nil)

      When set to true, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.

    • include_inactive (::Boolean) (defaults to: nil)

      When set to true, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.

    • action (::Google::Cloud::Debugger::V2::ListBreakpointsRequest::BreakpointActionValue, ::Hash) (defaults to: nil)

      When set, the response includes only breakpoints with the specified action.

    • strip_results (::Boolean) (defaults to: nil)

      This field is deprecated. The following fields are always stripped out of the result: stack_frames, evaluated_expressions and variable_table.

    • wait_token (::String) (defaults to: nil)

      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.

    • client_version (::String) (defaults to: nil)

      Required. The client version making the call. Schema: domain/type/version (e.g., google.com/intellij/v1).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
# 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
   = @config.rpcs.list_breakpoints..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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) ⇒ ::Google::Cloud::Debugger::V2::ListDebuggeesResponse #list_debuggees(project: nil, include_inactive: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::ListDebuggeesResponse

Lists all the debuggees that the user has access to.

Overloads:

  • #list_debuggees(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::ListDebuggeesResponse

    Pass arguments to list_debuggees via a request object, either of type ListDebuggeesRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_debuggees(project: nil, include_inactive: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::ListDebuggeesResponse

    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).

    Parameters:

    • project (::String) (defaults to: nil)

      Required. Project number of a Google Cloud project whose debuggees to list.

    • include_inactive (::Boolean) (defaults to: nil)

      When set to true, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.

    • client_version (::String) (defaults to: nil)

      Required. The client version making the call. Schema: domain/type/version (e.g., google.com/intellij/v1).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
# 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
   = @config.rpcs.list_debuggees..to_h

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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) ⇒ ::Google::Cloud::Debugger::V2::SetBreakpointResponse #set_breakpoint(debuggee_id: nil, breakpoint: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::SetBreakpointResponse

Sets the breakpoint to the debuggee.

Overloads:

  • #set_breakpoint(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::SetBreakpointResponse

    Pass arguments to set_breakpoint via a request object, either of type SetBreakpointRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #set_breakpoint(debuggee_id: nil, breakpoint: nil, client_version: nil) ⇒ ::Google::Cloud::Debugger::V2::SetBreakpointResponse

    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).

    Parameters:

    • debuggee_id (::String) (defaults to: nil)

      Required. ID of the debuggee where the breakpoint is to be set.

    • breakpoint (::Google::Cloud::Debugger::V2::Breakpoint, ::Hash) (defaults to: nil)

      Required. Breakpoint specification to set. The field location of the breakpoint must be set.

    • client_version (::String) (defaults to: nil)

      Required. The client version making the call. Schema: domain/type/version (e.g., google.com/intellij/v1).

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# 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
   = @config.rpcs.set_breakpoint..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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