Interface DebuggeeOrBuilder (1.42.0)

public interface DebuggeeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getAgentVersion()

public abstract 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 abstract 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.

getDescription()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getId()

Unique identifier for the debuggee generated by the controller service.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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

getProject()

public abstract 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 abstract 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.

getSourceContexts(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.