Class Debuggee (1.55.0) 

public final class Debuggee extends GeneratedMessageV3 implements DebuggeeOrBuilder

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Debuggee

Implements

DebuggeeOrBuilder

Static Fields

AGENT_VERSION_FIELD_NUMBER

public static final int AGENT_VERSION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXT_SOURCE_CONTEXTS_FIELD_NUMBER

public static final int EXT_SOURCE_CONTEXTS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

IS_DISABLED_FIELD_NUMBER

public static final int IS_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

IS_INACTIVE_FIELD_NUMBER

public static final int IS_INACTIVE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_CONTEXTS_FIELD_NUMBER

public static final int SOURCE_CONTEXTS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

UNIQUIFIER_FIELD_NUMBER

public static final int UNIQUIFIER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Debuggee getDefaultInstance()
Returns
Type Description
Debuggee

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Debuggee.Builder newBuilder()
Returns
Type Description
Debuggee.Builder

newBuilder(Debuggee prototype)

public static Debuggee.Builder newBuilder(Debuggee prototype)
Parameter
Name Description
prototype Debuggee
Returns
Type Description
Debuggee.Builder

parseDelimitedFrom(InputStream input)

public static Debuggee parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Debuggee
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Debuggee parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Debuggee
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Debuggee parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Debuggee
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Debuggee parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Debuggee
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Debuggee parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Debuggee
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Debuggee parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Debuggee
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Debuggee parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Debuggee
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Debuggee parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Debuggee
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Debuggee parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Debuggee
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Debuggee parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Debuggee
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Debuggee parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Debuggee
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Debuggee parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Debuggee
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Debuggee> parser()
Returns
Type Description
Parser<Debuggee>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentVersion()

public String getAgentVersion()

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

public ByteString getAgentVersionBytes()

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

public Debuggee getDefaultInstanceForType()
Returns
Type Description
Debuggee

getDescription()

public String getDescription()

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

public ByteString getDescriptionBytes()

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

public ExtendedSourceContext getExtSourceContexts(int index)

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
ExtendedSourceContext

getExtSourceContextsCount() (deprecated)

public int getExtSourceContextsCount()

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

public List<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
List<ExtendedSourceContext>

getExtSourceContextsOrBuilder(int index) (deprecated)

public ExtendedSourceContextOrBuilder getExtSourceContextsOrBuilder(int index)

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
ExtendedSourceContextOrBuilder

getExtSourceContextsOrBuilderList() (deprecated)

public List<? extends ExtendedSourceContextOrBuilder> 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()

public String getId()

Unique identifier for the debuggee generated by the controller service.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Unique identifier for the debuggee generated by the controller service.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getIsDisabled()

public boolean getIsDisabled()

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

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.

bool is_inactive = 5;

Returns
Type Description
boolean

The isInactive.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

public Map<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
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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
String

getParserForType()

public Parser<Debuggee> getParserForType()
Returns
Type Description
Parser<Debuggee>
Overrides

getProject()

public String getProject()

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

public ByteString getProjectBytes()

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

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceContexts(int index)

public SourceContext getSourceContexts(int index)

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
SourceContext

getSourceContextsCount()

public int getSourceContextsCount()

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

public List<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
List<SourceContext>

getSourceContextsOrBuilder(int index)

public SourceContextOrBuilder getSourceContextsOrBuilder(int index)

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
SourceContextOrBuilder

getSourceContextsOrBuilderList()

public List<? extends SourceContextOrBuilder> 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()

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.

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

Returns
Type Description
StatusMessage

The status.

getStatusOrBuilder()

public StatusMessageOrBuilder getStatusOrBuilder()

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
StatusMessageOrBuilder

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.

string uniquifier = 3;

Returns
Type Description
String

The uniquifier.

getUniquifierBytes()

public ByteString getUniquifierBytes()

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.

hasStatus()

public boolean hasStatus()

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

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Debuggee.Builder newBuilderForType()
Returns
Type Description
Debuggee.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Debuggee.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Debuggee.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Debuggee.Builder toBuilder()
Returns
Type Description
Debuggee.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException