Class: Google::Apis::ClouddebuggerV2::Debuggee

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/clouddebugger_v2/classes.rb,
generated/google/apis/clouddebugger_v2/representations.rb,
generated/google/apis/clouddebugger_v2/representations.rb

Overview

Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Debuggee

Returns a new instance of Debuggee.


386
387
388
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 386

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent_versionString

Version ID of the agent. Schema: domain/language-platform/vmajor.minor (for example google.com/java-gcp/v1.1). Corresponds to the JSON property agentVersion

Returns:

  • (String)

312
313
314
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 312

def agent_version
  @agent_version
end

#canary_modeString

Used when setting breakpoint canary for this debuggee. Corresponds to the JSON property canaryMode

Returns:

  • (String)

317
318
319
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 317

def canary_mode
  @canary_mode
end

#descriptionString

Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. Corresponds to the JSON property description

Returns:

  • (String)

323
324
325
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 323

def description
  @description
end

#ext_source_contextsArray<Google::Apis::ClouddebuggerV2::ExtendedSourceContext>

References to the locations and revisions of the source code used in the deployed application. Corresponds to the JSON property extSourceContexts


329
330
331
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 329

def ext_source_contexts
  @ext_source_contexts
end

#idString

Unique identifier for the debuggee generated by the controller service. Corresponds to the JSON property id

Returns:

  • (String)

334
335
336
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 334

def id
  @id
end

#is_disabledBoolean Also known as: is_disabled?

If set to true, indicates that the agent should disable itself and detach from the debuggee. Corresponds to the JSON property isDisabled

Returns:

  • (Boolean)

340
341
342
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 340

def is_disabled
  @is_disabled
end

#is_inactiveBoolean Also known as: is_inactive?

If set to true, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. Corresponds to the JSON property isInactive

Returns:

  • (Boolean)

347
348
349
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 347

def is_inactive
  @is_inactive
end

#labelsHash<String,String>

A set of custom debuggee properties, populated by the agent, to be displayed to the user. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)

354
355
356
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 354

def labels
  @labels
end

#projectString

Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project. Corresponds to the JSON property project

Returns:

  • (String)

360
361
362
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 360

def project
  @project
end

#source_contextsArray<Google::Apis::ClouddebuggerV2::SourceContext>

References to the locations and revisions of the source code used in the deployed application. Corresponds to the JSON property sourceContexts


366
367
368
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 366

def source_contexts
  @source_contexts
end

#statusGoogle::Apis::ClouddebuggerV2::StatusMessage

Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message Location not found. Corresponds to the JSON property status


374
375
376
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 374

def status
  @status
end

#uniquifierString

Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment. Corresponds to the JSON property uniquifier

Returns:

  • (String)

384
385
386
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 384

def uniquifier
  @uniquifier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


391
392
393
394
395
396
397
398
399
400
401
402
403
404
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 391

def update!(**args)
  @agent_version = args[:agent_version] if args.key?(:agent_version)
  @canary_mode = args[:canary_mode] if args.key?(:canary_mode)
  @description = args[:description] if args.key?(:description)
  @ext_source_contexts = args[:ext_source_contexts] if args.key?(:ext_source_contexts)
  @id = args[:id] if args.key?(:id)
  @is_disabled = args[:is_disabled] if args.key?(:is_disabled)
  @is_inactive = args[:is_inactive] if args.key?(:is_inactive)
  @labels = args[:labels] if args.key?(:labels)
  @project = args[:project] if args.key?(:project)
  @source_contexts = args[:source_contexts] if args.key?(:source_contexts)
  @status = args[:status] if args.key?(:status)
  @uniquifier = args[:uniquifier] if args.key?(:uniquifier)
end