public final class Breakpoint extends GeneratedMessageV3 implements BreakpointOrBuilder
Represents the breakpoint specification, status and results.
Protobuf type google.devtools.clouddebugger.v2.Breakpoint
Static Fields
public static final int ACTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CONDITION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EVALUATED_EXPRESSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EXPRESSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FINAL_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int IS_FINAL_STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LOCATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LOG_LEVEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LOG_MESSAGE_FORMAT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STACK_FRAMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATUS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int USER_EMAIL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int VARIABLE_TABLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Breakpoint getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Breakpoint.Builder newBuilder()
public static Breakpoint.Builder newBuilder(Breakpoint prototype)
public static Breakpoint parseDelimitedFrom(InputStream input)
public static Breakpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Breakpoint parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Breakpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Breakpoint parseFrom(ByteString data)
public static Breakpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Breakpoint parseFrom(CodedInputStream input)
public static Breakpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Breakpoint parseFrom(InputStream input)
public static Breakpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Breakpoint parseFrom(ByteBuffer data)
public static Breakpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Breakpoint> parser()
Methods
public 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
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public 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;
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Time this breakpoint was created by the server in seconds resolution.
.google.protobuf.Timestamp create_time = 11;
public Breakpoint getDefaultInstanceForType()
public 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
|
public 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 | |
public 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;
public 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
|
public 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> | |
public 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 | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The expressions at the given index.
|
public 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 | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the expressions at the given index.
|
public 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.
|
public ProtocolStringList 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;
public 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.
|
public TimestampOrBuilder getFinalTimeOrBuilder()
Time this breakpoint was finalized as seen by the server in seconds
resolution.
.google.protobuf.Timestamp final_time = 12;
Breakpoint identifier, unique in the scope of the debuggee.
string id = 1;
| Returns |
|---|
| Type | Description |
String | The id.
|
public ByteString getIdBytes()
Breakpoint identifier, unique in the scope of the debuggee.
string id = 1;
public 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.
|
public Map<String,String> getLabels()
public 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 | |
public 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;
public 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;
public 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
|
public SourceLocation getLocation()
Breakpoint source location.
.google.devtools.clouddebugger.v2.SourceLocation location = 2;
public SourceLocationOrBuilder getLocationOrBuilder()
Breakpoint source location.
.google.devtools.clouddebugger.v2.SourceLocation location = 2;
public Breakpoint.LogLevel getLogLevel()
Indicates the severity of the log. Only relevant when action is LOG.
.google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;
public 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.
|
public 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.
|
public 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.
|
public Parser<Breakpoint> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public 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
|
public 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 | |
public 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;
public 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
|
public 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> | |
public 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 number referring to locationField f not found in class C referring to condition
.google.devtools.clouddebugger.v2.StatusMessage status = 10;
public 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 number referring to locationField f not found in class C referring to condition
.google.devtools.clouddebugger.v2.StatusMessage status = 10;
public final UnknownFieldSet getUnknownFields()
Overrides
public String getUserEmail()
E-mail address of the user that created this breakpoint
string user_email = 16;
| Returns |
|---|
| Type | Description |
String | The userEmail.
|
public ByteString getUserEmailBytes()
E-mail address of the user that created this breakpoint
string user_email = 16;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for userEmail.
|
public 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
|
public 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 | |
public 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;
public 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
|
public 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> | |
public 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.
|
public 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.
|
public boolean hasLocation()
Breakpoint source location.
.google.devtools.clouddebugger.v2.SourceLocation location = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the location field is set.
|
public 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 number referring to locationField f not found in class C referring to condition
.google.devtools.clouddebugger.v2.StatusMessage status = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the status field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public Breakpoint.Builder newBuilderForType()
protected Breakpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Breakpoint.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
