- 1.55.0 (latest)
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.1.10
public interface BreakpointOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
map<string, string> labels = 17;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAction()
public abstract Breakpoint.Action getAction()Action that the agent should perform when the code at the breakpoint location is hit.
.google.devtools.clouddebugger.v2.Breakpoint.Action action = 13;
| Returns | |
|---|---|
| Type | Description |
Breakpoint.Action | The action. |
getActionValue()
public abstract int getActionValue()Action that the agent should perform when the code at the breakpoint location is hit.
.google.devtools.clouddebugger.v2.Breakpoint.Action action = 13;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for action. |
getCondition()
public abstract String getCondition()Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
string condition = 3;
| Returns | |
|---|---|
| Type | Description |
String | The condition. |
getConditionBytes()
public abstract ByteString getConditionBytes()Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
string condition = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for condition. |
getCreateTime()
public abstract Timestamp getCreateTime()Time this breakpoint was created by the server in seconds resolution.
.google.protobuf.Timestamp create_time = 11;
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Time this breakpoint was created by the server in seconds resolution.
.google.protobuf.Timestamp create_time = 11;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getEvaluatedExpressions(int index)
public abstract Variable getEvaluatedExpressions(int index) Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions field.
The name field holds the original expression text, the value or
members field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status inside the Variable
will indicate an error and contain the error text.
repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Variable | |
getEvaluatedExpressionsCount()
public abstract int getEvaluatedExpressionsCount() Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions field.
The name field holds the original expression text, the value or
members field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status inside the Variable
will indicate an error and contain the error text.
repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;
| Returns | |
|---|---|
| Type | Description |
int | |
getEvaluatedExpressionsList()
public abstract List<Variable> getEvaluatedExpressionsList() Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions field.
The name field holds the original expression text, the value or
members field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status inside the Variable
will indicate an error and contain the error text.
repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;
| Returns | |
|---|---|
| Type | Description |
List<Variable> | |
getEvaluatedExpressionsOrBuilder(int index)
public abstract VariableOrBuilder getEvaluatedExpressionsOrBuilder(int index) Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions field.
The name field holds the original expression text, the value or
members field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status inside the Variable
will indicate an error and contain the error text.
repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
VariableOrBuilder | |
getEvaluatedExpressionsOrBuilderList()
public abstract List<? extends VariableOrBuilder> getEvaluatedExpressionsOrBuilderList() Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they
are listed in the expressions field.
The name field holds the original expression text, the value or
members field holds the result of the evaluated expression.
If the expression cannot be evaluated, the status inside the Variable
will indicate an error and contain the error text.
repeated .google.devtools.clouddebugger.v2.Variable evaluated_expressions = 8;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.devtools.clouddebugger.v2.VariableOrBuilder> | |
getExpressions(int index)
public abstract String getExpressions(int index) List of read-only expressions to evaluate at the breakpoint location.
The expressions are composed using expressions in the programming language
at the source location. If the breakpoint action is LOG, the evaluated
expressions are included in log statements.
repeated string expressions = 4;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The expressions at the given index. |
getExpressionsBytes(int index)
public abstract ByteString getExpressionsBytes(int index) List of read-only expressions to evaluate at the breakpoint location.
The expressions are composed using expressions in the programming language
at the source location. If the breakpoint action is LOG, the evaluated
expressions are included in log statements.
repeated string expressions = 4;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the expressions at the given index. |
getExpressionsCount()
public abstract int getExpressionsCount() List of read-only expressions to evaluate at the breakpoint location.
The expressions are composed using expressions in the programming language
at the source location. If the breakpoint action is LOG, the evaluated
expressions are included in log statements.
repeated string expressions = 4;
| Returns | |
|---|---|
| Type | Description |
int | The count of expressions. |
getExpressionsList()
public abstract List<String> getExpressionsList() List of read-only expressions to evaluate at the breakpoint location.
The expressions are composed using expressions in the programming language
at the source location. If the breakpoint action is LOG, the evaluated
expressions are included in log statements.
repeated string expressions = 4;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the expressions. |
getFinalTime()
public abstract Timestamp getFinalTime()Time this breakpoint was finalized as seen by the server in seconds resolution.
.google.protobuf.Timestamp final_time = 12;
| Returns | |
|---|---|
| Type | Description |
Timestamp | The finalTime. |
getFinalTimeOrBuilder()
public abstract TimestampOrBuilder getFinalTimeOrBuilder()Time this breakpoint was finalized as seen by the server in seconds resolution.
.google.protobuf.Timestamp final_time = 12;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getId()
public abstract String getId()Breakpoint identifier, unique in the scope of the debuggee.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
String | The id. |
getIdBytes()
public abstract ByteString getIdBytes()Breakpoint identifier, unique in the scope of the debuggee.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for id. |
getIsFinalState()
public abstract boolean getIsFinalState()When true, indicates that this is a final result and the breakpoint state will not change from here on.
bool is_final_state = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | The isFinalState. |
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public abstract int getLabelsCount()A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
map<string, string> labels = 17;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public abstract Map<String,String> getLabelsMap()A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
map<string, string> labels = 17;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
map<string, string> labels = 17;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
map<string, string> labels = 17;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLocation()
public abstract SourceLocation getLocation()Breakpoint source location.
.google.devtools.clouddebugger.v2.SourceLocation location = 2;
| Returns | |
|---|---|
| Type | Description |
SourceLocation | The location. |
getLocationOrBuilder()
public abstract SourceLocationOrBuilder getLocationOrBuilder()Breakpoint source location.
.google.devtools.clouddebugger.v2.SourceLocation location = 2;
| Returns | |
|---|---|
| Type | Description |
SourceLocationOrBuilder | |
getLogLevel()
public abstract Breakpoint.LogLevel getLogLevel() Indicates the severity of the log. Only relevant when action is LOG.
.google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;
| Returns | |
|---|---|
| Type | Description |
Breakpoint.LogLevel | The logLevel. |
getLogLevelValue()
public abstract int getLogLevelValue() Indicates the severity of the log. Only relevant when action is LOG.
.google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for logLevel. |
getLogMessageFormat()
public abstract String getLogMessageFormat() Only relevant when action is LOG. Defines the message to log when
the breakpoint hits. The message may include parameter placeholders $0,
$1, etc. These placeholders are replaced with the evaluated value
of the appropriate expression. Expressions not referenced in
log_message_format are not logged.
Example: Message received, id = $0, count = $1 with
expressions = [ message.id, message.count ].
string log_message_format = 14;
| Returns | |
|---|---|
| Type | Description |
String | The logMessageFormat. |
getLogMessageFormatBytes()
public abstract ByteString getLogMessageFormatBytes() Only relevant when action is LOG. Defines the message to log when
the breakpoint hits. The message may include parameter placeholders $0,
$1, etc. These placeholders are replaced with the evaluated value
of the appropriate expression. Expressions not referenced in
log_message_format are not logged.
Example: Message received, id = $0, count = $1 with
expressions = [ message.id, message.count ].
string log_message_format = 14;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for logMessageFormat. |
getStackFrames(int index)
public abstract StackFrame getStackFrames(int index)The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
StackFrame | |
getStackFramesCount()
public abstract int getStackFramesCount()The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
getStackFramesList()
public abstract List<StackFrame> getStackFramesList()The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;
| Returns | |
|---|---|
| Type | Description |
List<StackFrame> | |
getStackFramesOrBuilder(int index)
public abstract StackFrameOrBuilder getStackFramesOrBuilder(int index)The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
StackFrameOrBuilder | |
getStackFramesOrBuilderList()
public abstract List<? extends StackFrameOrBuilder> getStackFramesOrBuilderList()The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.devtools.clouddebugger.v2.StackFrameOrBuilder> | |
getStatus()
public abstract StatusMessage getStatus()Breakpoint status.
The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user.
Error status indicates complete failure of the breakpoint.
Example (non-final state): Still loading symbols...
Examples (final state):
Invalid line numberreferring to locationField f not found in class Creferring to condition
.google.devtools.clouddebugger.v2.StatusMessage status = 10;
| Returns | |
|---|---|
| Type | Description |
StatusMessage | The status. |
getStatusOrBuilder()
public abstract StatusMessageOrBuilder getStatusOrBuilder()Breakpoint status.
The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user.
Error status indicates complete failure of the breakpoint.
Example (non-final state): Still loading symbols...
Examples (final state):
Invalid line numberreferring to locationField f not found in class Creferring to condition
.google.devtools.clouddebugger.v2.StatusMessage status = 10;
| Returns | |
|---|---|
| Type | Description |
StatusMessageOrBuilder | |
getUserEmail()
public abstract String getUserEmail()E-mail address of the user that created this breakpoint
string user_email = 16;
| Returns | |
|---|---|
| Type | Description |
String | The userEmail. |
getUserEmailBytes()
public abstract ByteString getUserEmailBytes()E-mail address of the user that created this breakpoint
string user_email = 16;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for userEmail. |
getVariableTable(int index)
public abstract Variable getVariableTable(int index) The variable_table exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the
variable_table itself.
For example, the same this object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Variable | |
getVariableTableCount()
public abstract int getVariableTableCount() The variable_table exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the
variable_table itself.
For example, the same this object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;
| Returns | |
|---|---|
| Type | Description |
int | |
getVariableTableList()
public abstract List<Variable> getVariableTableList() The variable_table exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the
variable_table itself.
For example, the same this object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;
| Returns | |
|---|---|
| Type | Description |
List<Variable> | |
getVariableTableOrBuilder(int index)
public abstract VariableOrBuilder getVariableTableOrBuilder(int index) The variable_table exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the
variable_table itself.
For example, the same this object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
VariableOrBuilder | |
getVariableTableOrBuilderList()
public abstract List<? extends VariableOrBuilder> getVariableTableOrBuilderList() The variable_table exists to aid with computation, memory and network
traffic optimization. It enables storing a variable once and reference
it from multiple variables, including variables stored in the
variable_table itself.
For example, the same this object, which may appear at many levels of
the stack, can have all of its data stored once in this table. The
stack frame variables then would hold only a reference to it.
The variable var_table_index field is an index into this repeated field.
The stored objects are nameless and get their name from the referencing
variable. The effective variable is a merge of the referencing variable
and the referenced variable.
repeated .google.devtools.clouddebugger.v2.Variable variable_table = 9;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.devtools.clouddebugger.v2.VariableOrBuilder> | |
hasCreateTime()
public abstract boolean hasCreateTime()Time this breakpoint was created by the server in seconds resolution.
.google.protobuf.Timestamp create_time = 11;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasFinalTime()
public abstract boolean hasFinalTime()Time this breakpoint was finalized as seen by the server in seconds resolution.
.google.protobuf.Timestamp final_time = 12;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the finalTime field is set. |
hasLocation()
public abstract boolean hasLocation()Breakpoint source location.
.google.devtools.clouddebugger.v2.SourceLocation location = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the location field is set. |
hasStatus()
public abstract boolean hasStatus()Breakpoint status.
The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user.
Error status indicates complete failure of the breakpoint.
Example (non-final state): Still loading symbols...
Examples (final state):
Invalid line numberreferring to locationField f not found in class Creferring to condition
.google.devtools.clouddebugger.v2.StatusMessage status = 10;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the status field is set. |