Class: Google::Apis::ClouddebuggerV2::CloudDebuggerService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/clouddebugger_v2/service.rb

Overview

Stackdriver Debugger API

Examines the call stack and variables of a running application without stopping or slowing it down.

Examples:

require 'google/apis/clouddebugger_v2'

Clouddebugger = Google::Apis::ClouddebuggerV2 # Alias the module
service = Clouddebugger::CloudDebuggerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ CloudDebuggerService

Returns a new instance of CloudDebuggerService.



46
47
48
49
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 46

def initialize
  super('https://clouddebugger.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#delete_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::Empty

Deletes the breakpoint from the debuggee.

Parameters:

  • debuggee_id (String) —

    Required. ID of the debuggee whose breakpoint to delete.

  • breakpoint_id (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



246
247
248
249
250
251
252
253
254
255
256
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 246

def delete_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}', options)
  command.response_representation = Google::Apis::ClouddebuggerV2::Empty::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::Empty
  command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
  command.params['breakpointId'] = breakpoint_id unless breakpoint_id.nil?
  command.query['clientVersion'] = client_version unless client_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::GetBreakpointResponse

Gets breakpoint information.

Parameters:

  • debuggee_id (String) —

    Required. ID of the debuggee whose breakpoint to get.

  • breakpoint_id (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



283
284
285
286
287
288
289
290
291
292
293
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 283

def get_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}', options)
  command.response_representation = Google::Apis::ClouddebuggerV2::GetBreakpointResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::GetBreakpointResponse
  command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
  command.params['breakpointId'] = breakpoint_id unless breakpoint_id.nil?
  command.query['clientVersion'] = client_version unless client_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_controller_debuggee_breakpoints(debuggee_id, success_on_timeout: nil, wait_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse

Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expressions fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

Parameters:

  • debuggee_id (String) —

    Required. Identifies the debuggee.

  • success_on_timeout (Boolean) (defaults to: nil) —

    If set to true (recommended), returns google.rpc.Code.OK status and sets the wait_expired response field to true when the server-selected timeout has expired. If set to false (deprecated), returns google.rpc.Code.ABORTED status when the server-selected timeout has expired.

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

    A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the next_wait_token field in the last response. The initial value should be set to "init".

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



129
130
131
132
133
134
135
136
137
138
139
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 129

def list_controller_debuggee_breakpoints(debuggee_id, success_on_timeout: nil, wait_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/controller/debuggees/{debuggeeId}/breakpoints', options)
  command.response_representation = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse
  command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
  command.query['successOnTimeout'] = success_on_timeout unless success_on_timeout.nil?
  command.query['waitToken'] = wait_token unless wait_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_debugger_debuggee_breakpoints(debuggee_id, action_value: nil, client_version: nil, include_all_users: nil, include_inactive: nil, strip_results: nil, wait_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::ListBreakpointsResponse

Lists all breakpoints for the debuggee.

Parameters:

  • debuggee_id (String) —

    Required. ID of the debuggee whose breakpoints to list.

  • action_value (String) (defaults to: nil) —

    Only breakpoints with the specified action will pass the filter.

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

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 335

def list_debugger_debuggee_breakpoints(debuggee_id, action_value: nil, client_version: nil, include_all_users: nil, include_inactive: nil, strip_results: nil, wait_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/debugger/debuggees/{debuggeeId}/breakpoints', options)
  command.response_representation = Google::Apis::ClouddebuggerV2::ListBreakpointsResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::ListBreakpointsResponse
  command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
  command.query['action.value'] = action_value unless action_value.nil?
  command.query['clientVersion'] = client_version unless client_version.nil?
  command.query['includeAllUsers'] = include_all_users unless include_all_users.nil?
  command.query['includeInactive'] = include_inactive unless include_inactive.nil?
  command.query['stripResults'] = strip_results unless strip_results.nil?
  command.query['waitToken'] = wait_token unless wait_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_debugger_debuggees(client_version: nil, include_inactive: nil, project: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::ListDebuggeesResponse

Lists all the debuggees that the user has access to.

Parameters:

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

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

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

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



209
210
211
212
213
214
215
216
217
218
219
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 209

def list_debugger_debuggees(client_version: nil, include_inactive: nil, project: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/debugger/debuggees', options)
  command.response_representation = Google::Apis::ClouddebuggerV2::ListDebuggeesResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::ListDebuggeesResponse
  command.query['clientVersion'] = client_version unless client_version.nil?
  command.query['includeInactive'] = include_inactive unless include_inactive.nil?
  command.query['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#register_debuggee(register_debuggee_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse

Registers the debuggee with the controller service. All agents attached to the same application must call this method with exactly the same request content to get back the same stable debuggee_id. Agents should call this method again whenever google.rpc.Code.NOT_FOUND is returned from any controller method. This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters:

  • register_debuggee_request_object (Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



77
78
79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 77

def register_debuggee(register_debuggee_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/controller/debuggees/register', options)
  command.request_representation = Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest::Representation
  command.request_object = register_debuggee_request_object
  command.response_representation = Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_debugger_debuggee_breakpoint(debuggee_id, breakpoint_object = nil, client_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::SetBreakpointResponse

Sets the breakpoint to the debuggee.

Parameters:

  • debuggee_id (String) —

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

  • breakpoint_object (Google::Apis::ClouddebuggerV2::Breakpoint) (defaults to: nil)
  • client_version (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 375

def set_debugger_debuggee_breakpoint(debuggee_id, breakpoint_object = nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/set', options)
  command.request_representation = Google::Apis::ClouddebuggerV2::Breakpoint::Representation
  command.request_object = breakpoint_object
  command.response_representation = Google::Apis::ClouddebuggerV2::SetBreakpointResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::SetBreakpointResponse
  command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
  command.query['clientVersion'] = client_version unless client_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_active_breakpoint(debuggee_id, id, update_active_breakpoint_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the location, condition and expressions fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Parameters:

  • debuggee_id (String) —

    Required. Identifies the debuggee being debugged.

  • id (String) —

    Breakpoint identifier, unique in the scope of the debuggee.

  • update_active_breakpoint_request_object (Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'generated/google/apis/clouddebugger_v2/service.rb', line 170

def update_active_breakpoint(debuggee_id, id, update_active_breakpoint_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v2/controller/debuggees/{debuggeeId}/breakpoints/{id}', options)
  command.request_representation = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointRequest::Representation
  command.request_object = update_active_breakpoint_request_object
  command.response_representation = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse::Representation
  command.response_class = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse
  command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end