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 application to debug. 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. The agents attached to the same debuggee are identified by using exactly the same field values 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



529
530
531
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 529

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

Instance Attribute Details

#agent_versionString

Version ID of the agent release. The version ID is structured as following: domain/type/vmajor.minor (for example google.com/gcp-java/v1.1). Corresponds to the JSON property agentVersion

Returns:

  • (String)


497
498
499
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 497

def agent_version
  @agent_version
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)


511
512
513
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 511

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. Contexts describing a remote repo related to the source code have a category label of remote_repo. Source snapshot source contexts have a category of snapshot. Corresponds to the JSON property extSourceContexts



457
458
459
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 457

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)


490
491
492
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 490

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)


503
504
505
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 503

def is_disabled
  @is_disabled
end

#is_inactiveBoolean Also known as: is_inactive?

If set to true, indicates that the debuggee is considered as inactive by the Controller service. Corresponds to the JSON property isInactive

Returns:

  • (Boolean)


469
470
471
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 469

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


463
464
465
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 463

def labels
  @labels
end

#projectString

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

Returns:

  • (String)


485
486
487
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 485

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. NOTE: This field is deprecated. Consumers should use ext_source_contexts if it is not empty. Debug agents should populate both this field and ext_source_contexts. Corresponds to the JSON property sourceContexts



527
528
529
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 527

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



479
480
481
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 479

def status
  @status
end

#uniquifierString

Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended. Corresponds to the JSON property uniquifier

Returns:

  • (String)


518
519
520
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 518

def uniquifier
  @uniquifier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



534
535
536
537
538
539
540
541
542
543
544
545
546
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 534

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