Class: Google::Apis::ClouddebuggerV2::Debuggee
- Inherits:
-
Object
- Object
- Google::Apis::ClouddebuggerV2::Debuggee
- 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
-
#agent_version ⇒ String
Version ID of the agent release.
-
#description ⇒ String
Human readable description of the debuggee.
-
#ext_source_contexts ⇒ Array<Google::Apis::ClouddebuggerV2::ExtendedSourceContext>
References to the locations and revisions of the source code used in the deployed application.
-
#id ⇒ String
Unique identifier for the debuggee generated by the controller service.
-
#is_disabled ⇒ Boolean
(also: #is_disabled?)
If set to
true, indicates that the agent should disable itself and detach from the debuggee. -
#is_inactive ⇒ Boolean
(also: #is_inactive?)
If set to
true, indicates that the debuggee is considered as inactive by the Controller service. -
#labels ⇒ Hash<String,String>
A set of custom debuggee properties, populated by the agent, to be displayed to the user.
-
#project ⇒ String
Project the debuggee is associated with.
-
#source_contexts ⇒ Array<Google::Apis::ClouddebuggerV2::SourceContext>
References to the locations and revisions of the source code used in the deployed application.
-
#status ⇒ Google::Apis::ClouddebuggerV2::StatusMessage
Represents a contextual status message.
-
#uniquifier ⇒ String
Debuggee uniquifier within the project.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Debuggee
constructor
A new instance of Debuggee.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Debuggee
Returns a new instance of Debuggee
204 205 206 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 204 def initialize(**args) update!(**args) end |
Instance Attribute Details
#agent_version ⇒ String
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
172 173 174 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 172 def agent_version @agent_version end |
#description ⇒ String
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
186 187 188 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 186 def description @description end |
#ext_source_contexts ⇒ Array<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
132 133 134 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 132 def ext_source_contexts @ext_source_contexts end |
#id ⇒ String
Unique identifier for the debuggee generated by the controller service.
Corresponds to the JSON property id
165 166 167 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 165 def id @id end |
#is_disabled ⇒ Boolean 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
178 179 180 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 178 def is_disabled @is_disabled end |
#is_inactive ⇒ Boolean 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
153 154 155 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 153 def is_inactive @is_inactive end |
#labels ⇒ Hash<String,String>
A set of custom debuggee properties, populated by the agent, to be
displayed to the user.
Corresponds to the JSON property labels
138 139 140 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 138 def labels @labels end |
#project ⇒ String
Project the debuggee is associated with.
Use the project number when registering a Google Cloud Platform project.
Corresponds to the JSON property project
160 161 162 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 160 def project @project end |
#source_contexts ⇒ Array<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
202 203 204 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 202 def source_contexts @source_contexts end |
#status ⇒ Google::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
147 148 149 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 147 def status @status end |
#uniquifier ⇒ String
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
193 194 195 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 193 def uniquifier @uniquifier end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'generated/google/apis/clouddebugger_v2/classes.rb', line 209 def update!(**args) @ext_source_contexts = args[:ext_source_contexts] if args.key?(:ext_source_contexts) @labels = args[:labels] if args.key?(:labels) @status = args[:status] if args.key?(:status) @is_inactive = args[:is_inactive] if args.key?(:is_inactive) @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 |