lib/google/cloud/debugger/v2/controller2_client.rb in google-cloud-debugger-0.32.4 vs lib/google/cloud/debugger/v2/controller2_client.rb in google-cloud-debugger-0.32.5
- old
+ new
@@ -36,14 +36,14 @@
# debugger agents to perform debugging tasks. These agents are each attached
# to a process of an application which may include one or more replicas.
#
# The debugger agents register with the Controller to identify the application
# being debugged, the Debuggee. All agents that register with the same data,
- # represent the same Debuggee, and are assigned the same +debuggee_id+.
+ # represent the same Debuggee, and are assigned the same `debuggee_id`.
#
# The debugger agents call the Controller to retrieve the list of active
- # Breakpoints. Agents with the same +debuggee_id+ get the same breakpoints
+ # Breakpoints. Agents with the same `debuggee_id` get the same breakpoints
# list. An agent that can fulfill the breakpoint request updates the
# Controller with the breakpoint result. The controller selects the first
# result received and discards the rest of the results.
# Agents that poll again for active breakpoints will no longer have
# the completed breakpoint in the list and should remove that breakpoint from
@@ -200,21 +200,21 @@
# Service calls
# 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+
+ # 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.
+ # from data loss, or change the `debuggee_id` format. Agents must handle
+ # `debuggee_id` value changing upon re-registration.
#
# @param debuggee [Google::Devtools::Clouddebugger::V2::Debuggee | Hash]
# Debuggee information to register.
- # The fields +project+, +uniquifier+, +description+ and +agent_version+
+ # The fields `project`, `uniquifier`, `description` and `agent_version`
# of the debuggee must be set.
# A hash of the same form as `Google::Devtools::Clouddebugger::V2::Debuggee`
# can also be provided.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
@@ -227,11 +227,11 @@
# @example
# require "google/cloud/debugger/v2"
#
# controller2_client = Google::Cloud::Debugger::V2::Controller2.new
#
- # # TODO: Initialize +debuggee+:
+ # # TODO: Initialize `debuggee`:
# debuggee = {}
# response = controller2_client.register_debuggee(debuggee)
def register_debuggee \
debuggee,
@@ -244,11 +244,11 @@
@register_debuggee.call(req, options, &block)
end
# Returns the list of all active breakpoints for the debuggee.
#
- # The breakpoint specification (+location+, +condition+, and +expressions+
+ # 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.
#
@@ -261,18 +261,18 @@
# @param debuggee_id [String]
# Identifies the debuggee.
# @param wait_token [String]
# 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"+.
+ # expired. The value should be set from the `next_wait_token` field in
+ # the last response. The initial value should be set to `"init"`.
# @param success_on_timeout [true, false]
- # If set to +true+ (recommended), returns +google.rpc.Code.OK+ status and
- # sets the +wait_expired+ response field to +true+ when the server-selected
+ # 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
+ # If set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status
# when the server-selected timeout has expired.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -283,11 +283,11 @@
# @example
# require "google/cloud/debugger/v2"
#
# controller2_client = Google::Cloud::Debugger::V2::Controller2.new
#
- # # TODO: Initialize +debuggee_id+:
+ # # TODO: Initialize `debuggee_id`:
# debuggee_id = ''
# response = controller2_client.list_active_breakpoints(debuggee_id)
def list_active_breakpoints \
debuggee_id,
@@ -306,20 +306,20 @@
# 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
+ # 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.
#
# @param debuggee_id [String]
# Identifies the debuggee being debugged.
# @param breakpoint [Google::Devtools::Clouddebugger::V2::Breakpoint | Hash]
# Updated breakpoint information.
- # The field +id+ must be set.
+ # The field `id` must be set.
# The agent must echo all Breakpoint specification fields in the update.
# A hash of the same form as `Google::Devtools::Clouddebugger::V2::Breakpoint`
# can also be provided.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
@@ -332,13 +332,13 @@
# @example
# require "google/cloud/debugger/v2"
#
# controller2_client = Google::Cloud::Debugger::V2::Controller2.new
#
- # # TODO: Initialize +debuggee_id+:
+ # # TODO: Initialize `debuggee_id`:
# debuggee_id = ''
#
- # # TODO: Initialize +breakpoint+:
+ # # TODO: Initialize `breakpoint`:
# breakpoint = {}
# response = controller2_client.update_active_breakpoint(debuggee_id, breakpoint)
def update_active_breakpoint \
debuggee_id,