com.google.api.services.clouddebugger.v2.model

Class Debuggee

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.clouddebugger.v2.model.Debuggee

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Debuggee
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Debugger API (Deprecated). For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Debuggee()

Method Summary

Modifier and Type	Method and Description
Debuggee	clone()
String	getAgentVersion() Version ID of the agent.
String	getCanaryMode() Used when setting breakpoint canary for this debuggee.
String	getDescription() Human readable description of the debuggee.
List<ExtendedSourceContext>	getExtSourceContexts() References to the locations and revisions of the source code used in the deployed application.
String	getId() Unique identifier for the debuggee generated by the controller service.
Boolean	getIsDisabled() If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
Boolean	getIsInactive() If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.
Map<String,String>	getLabels() A set of custom debuggee properties, populated by the agent, to be displayed to the user.
String	getProject() Project the debuggee is associated with.
List<SourceContext>	getSourceContexts() References to the locations and revisions of the source code used in the deployed application.
StatusMessage	getStatus() Human readable message to be displayed to the user about this debuggee.
String	getUniquifier() Uniquifier to further distinguish the application.
Debuggee	set(String fieldName, Object value)
Debuggee	setAgentVersion(String agentVersion) Version ID of the agent.
Debuggee	setCanaryMode(String canaryMode) Used when setting breakpoint canary for this debuggee.
Debuggee	setDescription(String description) Human readable description of the debuggee.
Debuggee	setExtSourceContexts(List<ExtendedSourceContext> extSourceContexts) References to the locations and revisions of the source code used in the deployed application.
Debuggee	setId(String id) Unique identifier for the debuggee generated by the controller service.
Debuggee	setIsDisabled(Boolean isDisabled) If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
Debuggee	setIsInactive(Boolean isInactive) If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.
Debuggee	setLabels(Map<String,String> labels) A set of custom debuggee properties, populated by the agent, to be displayed to the user.
Debuggee	setProject(String project) Project the debuggee is associated with.
Debuggee	setSourceContexts(List<SourceContext> sourceContexts) References to the locations and revisions of the source code used in the deployed application.
Debuggee	setStatus(StatusMessage status) Human readable message to be displayed to the user about this debuggee.
Debuggee	setUniquifier(String uniquifier) Uniquifier to further distinguish the application.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Debuggee

public Debuggee()

Method Detail

getAgentVersion

public String getAgentVersion()

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

Returns:

value or null for none

setAgentVersion

public Debuggee setAgentVersion(String agentVersion)

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

Parameters:

agentVersion - agentVersion or null for none

getCanaryMode

public String getCanaryMode()

Used when setting breakpoint canary for this debuggee.

Returns:

value or null for none

setCanaryMode

public Debuggee setCanaryMode(String canaryMode)

Used when setting breakpoint canary for this debuggee.

Parameters:

canaryMode - canaryMode or null for none

getDescription

public String getDescription()

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

Returns:

value or null for none

setDescription

public Debuggee setDescription(String description)

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

Parameters:

description - description or null for none

getExtSourceContexts

public List<ExtendedSourceContext> getExtSourceContexts()

References to the locations and revisions of the source code used in the deployed application.

Returns:

value or null for none

setExtSourceContexts

public Debuggee setExtSourceContexts(List<ExtendedSourceContext> extSourceContexts)

References to the locations and revisions of the source code used in the deployed application.

Parameters:

extSourceContexts - extSourceContexts or null for none

getId

public String getId()

Unique identifier for the debuggee generated by the controller service.

Returns:

value or null for none

setId

public Debuggee setId(String id)

Unique identifier for the debuggee generated by the controller service.

Parameters:

id - id or null for none

getIsDisabled

public Boolean getIsDisabled()

If set to `true`, indicates that the agent should disable itself and detach from the debuggee.

Returns:

value or null for none

setIsDisabled

public Debuggee setIsDisabled(Boolean isDisabled)

If set to `true`, indicates that the agent should disable itself and detach from the debuggee.

Parameters:

isDisabled - isDisabled or null for none

getIsInactive

public Boolean getIsInactive()

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

Returns:

value or null for none

setIsInactive

public Debuggee setIsInactive(Boolean isInactive)

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

Parameters:

isInactive - isInactive or null for none

getLabels

public Map<String,String> getLabels()

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

Returns:

value or null for none

setLabels

public Debuggee setLabels(Map<String,String> labels)

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

Parameters:

labels - labels or null for none

getProject

public String getProject()

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

Returns:

value or null for none

setProject

public Debuggee setProject(String project)

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

Parameters:

project - project or null for none

getSourceContexts

public List<SourceContext> getSourceContexts()

References to the locations and revisions of the source code used in the deployed application.

Returns:

value or null for none

setSourceContexts

public Debuggee setSourceContexts(List<SourceContext> sourceContexts)

References to the locations and revisions of the source code used in the deployed application.

Parameters:

sourceContexts - sourceContexts or null for none

getStatus

public StatusMessage getStatus()

Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.

Returns:

value or null for none

setStatus

public Debuggee setStatus(StatusMessage status)

Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.

Parameters:

status - status or null for none

getUniquifier

public String getUniquifier()

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.

Returns:

value or null for none

setUniquifier

public Debuggee setUniquifier(String uniquifier)

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.

Parameters:

uniquifier - uniquifier or null for none

set

public Debuggee set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Debuggee clone()

Overrides:

clone in class com.google.api.client.json.GenericJson