Class Debuggee (1.1.10)

publicfinalclass DebuggeeextendsGeneratedMessageV3implementsDebuggeeOrBuilder

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.

Protobuf type google.devtools.clouddebugger.v2.Debuggee

Implements

DebuggeeOrBuilder

Inherited Members

Static Fields

AGENT_VERSION_FIELD_NUMBER

publicstaticfinalintAGENT_VERSION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXT_SOURCE_CONTEXTS_FIELD_NUMBER

publicstaticfinalintEXT_SOURCE_CONTEXTS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

publicstaticfinalintID_FIELD_NUMBER
Field Value
Type Description
int

IS_DISABLED_FIELD_NUMBER

publicstaticfinalintIS_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

IS_INACTIVE_FIELD_NUMBER

publicstaticfinalintIS_INACTIVE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

publicstaticfinalintLABELS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

publicstaticfinalintPROJECT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_CONTEXTS_FIELD_NUMBER

publicstaticfinalintSOURCE_CONTEXTS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

publicstaticfinalintSTATUS_FIELD_NUMBER
Field Value
Type Description
int

UNIQUIFIER_FIELD_NUMBER

publicstaticfinalintUNIQUIFIER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticDebuggeegetDefaultInstance()
Returns
Type Description

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

newBuilder()

publicstaticDebuggee.BuildernewBuilder()
Returns
Type Description

newBuilder(Debuggee prototype)

publicstaticDebuggee.BuildernewBuilder(Debuggeeprototype)
Parameter
Name Description
prototype Debuggee
Returns
Type Description

parseDelimitedFrom(InputStream input)

publicstaticDebuggeeparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticDebuggeeparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data)

publicstaticDebuggeeparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticDebuggeeparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data)

publicstaticDebuggeeparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticDebuggeeparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input)

publicstaticDebuggeeparseFrom(CodedInputStreaminput)
Parameter
Name Description
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticDebuggeeparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input)

publicstaticDebuggeeparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticDebuggeeparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data)

publicstaticDebuggeeparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticDebuggeeparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parser()

publicstaticParser<Debuggee>parser()
Returns
Type Description

Methods

containsLabels(String key)

publicbooleancontainsLabels(Stringkey)

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

map<string, string> labels = 11;

Parameter
Name Description
key String
Returns
Type Description

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
Overrides

getAgentVersion()

publicStringgetAgentVersion()

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

string agent_version = 6;

Returns
Type Description
String

The agentVersion.

getAgentVersionBytes()

publicByteStringgetAgentVersionBytes()

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

string agent_version = 6;

Returns
Type Description
ByteString

The bytes for agentVersion.

getDefaultInstanceForType()

publicDebuggeegetDefaultInstanceForType()
Returns
Type Description

getDescription()

publicStringgetDescription()

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

string description = 4;

Returns
Type Description
String

The description.

getDescriptionBytes()

publicByteStringgetDescriptionBytes()

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

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

getExtSourceContexts(int index)

publicExtendedSourceContextgetExtSourceContexts(intindex)

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

repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description

getExtSourceContextsCount()

publicintgetExtSourceContextsCount()

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

repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];

Returns
Type Description
int

getExtSourceContextsList()

publicList<ExtendedSourceContext>getExtSourceContextsList()

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

repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];

Returns
Type Description

getExtSourceContextsOrBuilder(int index)

publicExtendedSourceContextOrBuildergetExtSourceContextsOrBuilder(intindex)

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

repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description

getExtSourceContextsOrBuilderList()

publicList<?extendsExtendedSourceContextOrBuilder>getExtSourceContextsOrBuilderList()

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

repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];

Returns
Type Description
List<? extends com.google.devtools.source.v1.ExtendedSourceContextOrBuilder>

getId()

publicStringgetId()

Unique identifier for the debuggee generated by the controller service.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

publicByteStringgetIdBytes()

Unique identifier for the debuggee generated by the controller service.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getIsDisabled()

publicbooleangetIsDisabled()

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

bool is_disabled = 7;

Returns
Type Description
boolean

The isDisabled.

getIsInactive()

publicbooleangetIsInactive()

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

bool is_inactive = 5;

Returns
Type Description
boolean

The isInactive.

getLabels()

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description

getLabelsCount()

publicintgetLabelsCount()

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

map<string, string> labels = 11;

Returns
Type Description
int

getLabelsMap()

publicMap<String,String>getLabelsMap()

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

map<string, string> labels = 11;

Returns
Type Description

getLabelsOrDefault(String key, String defaultValue)

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

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

map<string, string> labels = 11;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description

getLabelsOrThrow(String key)

publicStringgetLabelsOrThrow(Stringkey)

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

map<string, string> labels = 11;

Parameter
Name Description
key String
Returns
Type Description

getParserForType()

publicParser<Debuggee>getParserForType()
Returns
Type Description
Overrides

getProject()

publicStringgetProject()

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

string project = 2;

Returns
Type Description
String

The project.

getProjectBytes()

publicByteStringgetProjectBytes()

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

string project = 2;

Returns
Type Description
ByteString

The bytes for project.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSourceContexts(int index)

publicSourceContextgetSourceContexts(intindex)

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

repeated .google.devtools.source.v1.SourceContext source_contexts = 9;

Parameter
Name Description
index int
Returns
Type Description

getSourceContextsCount()

publicintgetSourceContextsCount()

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

repeated .google.devtools.source.v1.SourceContext source_contexts = 9;

Returns
Type Description
int

getSourceContextsList()

publicList<SourceContext>getSourceContextsList()

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

repeated .google.devtools.source.v1.SourceContext source_contexts = 9;

Returns
Type Description

getSourceContextsOrBuilder(int index)

publicSourceContextOrBuildergetSourceContextsOrBuilder(intindex)

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

repeated .google.devtools.source.v1.SourceContext source_contexts = 9;

Parameter
Name Description
index int
Returns
Type Description

getSourceContextsOrBuilderList()

publicList<?extendsSourceContextOrBuilder>getSourceContextsOrBuilderList()

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

repeated .google.devtools.source.v1.SourceContext source_contexts = 9;

Returns
Type Description
List<? extends com.google.devtools.source.v1.SourceContextOrBuilder>

getStatus()

publicStatusMessagegetStatus()

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.

.google.devtools.clouddebugger.v2.StatusMessage status = 8;

Returns
Type Description
StatusMessage

The status.

getStatusOrBuilder()

publicStatusMessageOrBuildergetStatusOrBuilder()

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.

.google.devtools.clouddebugger.v2.StatusMessage status = 8;

Returns
Type Description

getUniquifier()

publicStringgetUniquifier()

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.

string uniquifier = 3;

Returns
Type Description
String

The uniquifier.

getUniquifierBytes()

publicByteStringgetUniquifierBytes()

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.

string uniquifier = 3;

Returns
Type Description
ByteString

The bytes for uniquifier.

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
Overrides

hasStatus()

publicbooleanhasStatus()

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.

.google.devtools.clouddebugger.v2.StatusMessage status = 8;

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

internalGetMapField(int number)

protectedMapFieldinternalGetMapField(intnumber)
Parameter
Name Description
number int
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

newBuilderForType()

publicDebuggee.BuildernewBuilderForType()
Returns
Type Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedDebuggee.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
Returns
Type Description
Overrides

toBuilder()

publicDebuggee.BuildertoBuilder()
Returns
Type Description

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
Overrides Exceptions
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.