Class Breakpoint.Builder (1.48.0)

public static final class Breakpoint.Builder extends GeneratedMessageV3.Builder<Breakpoint.Builder> implements BreakpointOrBuilder

Represents the breakpoint specification, status and results.

Protobuf type google.devtools.clouddebugger.v2.Breakpoint

Implements

BreakpointOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllEvaluatedExpressions(Iterable<? extends Variable> values)

public Breakpoint.Builder addAllEvaluatedExpressions(Iterable<? extends Variable> values)

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
values Iterable<? extends com.google.devtools.clouddebugger.v2.Variable>
Returns
Type Description
Breakpoint.Builder

addAllExpressions(Iterable<String> values)

public Breakpoint.Builder addAllExpressions(Iterable<String> values)

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
values Iterable<String>

The expressions to add.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

addAllStackFrames(Iterable<? extends StackFrame> values)

public Breakpoint.Builder addAllStackFrames(Iterable<? extends StackFrame> values)

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
values Iterable<? extends com.google.devtools.clouddebugger.v2.StackFrame>
Returns
Type Description
Breakpoint.Builder

addAllVariableTable(Iterable<? extends Variable> values)

public Breakpoint.Builder addAllVariableTable(Iterable<? extends Variable> values)

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
values Iterable<? extends com.google.devtools.clouddebugger.v2.Variable>
Returns
Type Description
Breakpoint.Builder

addEvaluatedExpressions(Variable value)

public Breakpoint.Builder addEvaluatedExpressions(Variable value)

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
value Variable
Returns
Type Description
Breakpoint.Builder

addEvaluatedExpressions(Variable.Builder builderForValue)

public Breakpoint.Builder addEvaluatedExpressions(Variable.Builder builderForValue)

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
builderForValue Variable.Builder
Returns
Type Description
Breakpoint.Builder

addEvaluatedExpressions(int index, Variable value)

public Breakpoint.Builder addEvaluatedExpressions(int index, Variable value)

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;

Parameters
Name Description
index int
value Variable
Returns
Type Description
Breakpoint.Builder

addEvaluatedExpressions(int index, Variable.Builder builderForValue)

public Breakpoint.Builder addEvaluatedExpressions(int index, Variable.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Variable.Builder
Returns
Type Description
Breakpoint.Builder

addEvaluatedExpressionsBuilder()

public Variable.Builder addEvaluatedExpressionsBuilder()

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
Variable.Builder

addEvaluatedExpressionsBuilder(int index)

public Variable.Builder addEvaluatedExpressionsBuilder(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.Builder

addExpressions(String value)

public Breakpoint.Builder addExpressions(String value)

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
value String

The expressions to add.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

addExpressionsBytes(ByteString value)

public Breakpoint.Builder addExpressionsBytes(ByteString value)

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
value ByteString

The bytes of the expressions to add.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Breakpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Breakpoint.Builder
Overrides

addStackFrames(StackFrame value)

public Breakpoint.Builder addStackFrames(StackFrame value)

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
value StackFrame
Returns
Type Description
Breakpoint.Builder

addStackFrames(StackFrame.Builder builderForValue)

public Breakpoint.Builder addStackFrames(StackFrame.Builder builderForValue)

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
builderForValue StackFrame.Builder
Returns
Type Description
Breakpoint.Builder

addStackFrames(int index, StackFrame value)

public Breakpoint.Builder addStackFrames(int index, StackFrame value)

The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

Parameters
Name Description
index int
value StackFrame
Returns
Type Description
Breakpoint.Builder

addStackFrames(int index, StackFrame.Builder builderForValue)

public Breakpoint.Builder addStackFrames(int index, StackFrame.Builder builderForValue)

The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

Parameters
Name Description
index int
builderForValue StackFrame.Builder
Returns
Type Description
Breakpoint.Builder

addStackFramesBuilder()

public StackFrame.Builder addStackFramesBuilder()

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
StackFrame.Builder

addStackFramesBuilder(int index)

public StackFrame.Builder addStackFramesBuilder(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.Builder

addVariableTable(Variable value)

public Breakpoint.Builder addVariableTable(Variable value)

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
value Variable
Returns
Type Description
Breakpoint.Builder

addVariableTable(Variable.Builder builderForValue)

public Breakpoint.Builder addVariableTable(Variable.Builder builderForValue)

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
builderForValue Variable.Builder
Returns
Type Description
Breakpoint.Builder

addVariableTable(int index, Variable value)

public Breakpoint.Builder addVariableTable(int index, Variable value)

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;

Parameters
Name Description
index int
value Variable
Returns
Type Description
Breakpoint.Builder

addVariableTable(int index, Variable.Builder builderForValue)

public Breakpoint.Builder addVariableTable(int index, Variable.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Variable.Builder
Returns
Type Description
Breakpoint.Builder

addVariableTableBuilder()

public Variable.Builder addVariableTableBuilder()

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
Variable.Builder

addVariableTableBuilder(int index)

public Variable.Builder addVariableTableBuilder(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.Builder

build()

public Breakpoint build()
Returns
Type Description
Breakpoint

buildPartial()

public Breakpoint buildPartial()
Returns
Type Description
Breakpoint

clear()

public Breakpoint.Builder clear()
Returns
Type Description
Breakpoint.Builder
Overrides

clearAction()

public Breakpoint.Builder clearAction()

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.Builder

This builder for chaining.

clearCondition()

public Breakpoint.Builder clearCondition()

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
Breakpoint.Builder

This builder for chaining.

clearCreateTime()

public Breakpoint.Builder clearCreateTime()

Time this breakpoint was created by the server in seconds resolution.

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
Breakpoint.Builder

clearEvaluatedExpressions()

public Breakpoint.Builder clearEvaluatedExpressions()

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
Breakpoint.Builder

clearExpressions()

public Breakpoint.Builder clearExpressions()

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
Breakpoint.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Breakpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Breakpoint.Builder
Overrides

clearFinalTime()

public Breakpoint.Builder clearFinalTime()

Time this breakpoint was finalized as seen by the server in seconds resolution.

.google.protobuf.Timestamp final_time = 12;

Returns
Type Description
Breakpoint.Builder

clearId()

public Breakpoint.Builder clearId()

Breakpoint identifier, unique in the scope of the debuggee.

string id = 1;

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

clearIsFinalState()

public Breakpoint.Builder clearIsFinalState()

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
Breakpoint.Builder

This builder for chaining.

clearLabels()

public Breakpoint.Builder clearLabels()
Returns
Type Description
Breakpoint.Builder

clearLocation()

public Breakpoint.Builder clearLocation()

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Returns
Type Description
Breakpoint.Builder

clearLogLevel()

public Breakpoint.Builder clearLogLevel()

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.Builder

This builder for chaining.

clearLogMessageFormat()

public Breakpoint.Builder clearLogMessageFormat()

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
Breakpoint.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Breakpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Breakpoint.Builder
Overrides

clearStackFrames()

public Breakpoint.Builder clearStackFrames()

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
Breakpoint.Builder

clearStatus()

public Breakpoint.Builder clearStatus()

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 location
  • Field f not found in class C referring to condition

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

Returns
Type Description
Breakpoint.Builder

clearUserEmail()

public Breakpoint.Builder clearUserEmail()

E-mail address of the user that created this breakpoint

string user_email = 16;

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

clearVariableTable()

public Breakpoint.Builder clearVariableTable()

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
Breakpoint.Builder

clone()

public Breakpoint.Builder clone()
Returns
Type Description
Breakpoint.Builder
Overrides

containsLabels(String key)

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
Returns
Type Description
boolean

getAction()

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;

Returns
Type Description
Breakpoint.Action

The action.

getActionValue()

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.

getCondition()

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.

getConditionBytes()

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.

getCreateTime()

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Time this breakpoint was created by the server in seconds resolution.

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time this breakpoint was created by the server in seconds resolution.

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Breakpoint getDefaultInstanceForType()
Returns
Type Description
Breakpoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEvaluatedExpressions(int index)

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
Returns
Type Description
Variable

getEvaluatedExpressionsBuilder(int index)

public Variable.Builder getEvaluatedExpressionsBuilder(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.Builder

getEvaluatedExpressionsBuilderList()

public List<Variable.Builder> getEvaluatedExpressionsBuilderList()

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<Builder>

getEvaluatedExpressionsCount()

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

getEvaluatedExpressionsList()

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;

Returns
Type Description
List<Variable>

getEvaluatedExpressionsOrBuilder(int index)

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
Returns
Type Description
VariableOrBuilder

getEvaluatedExpressionsOrBuilderList()

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>

getExpressions(int index)

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.

getExpressionsBytes(int 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.

getExpressionsCount()

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.

getExpressionsList()

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;

Returns
Type Description
ProtocolStringList

A list containing the expressions.

getFinalTime()

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.

getFinalTimeBuilder()

public Timestamp.Builder getFinalTimeBuilder()

Time this breakpoint was finalized as seen by the server in seconds resolution.

.google.protobuf.Timestamp final_time = 12;

Returns
Type Description
Builder

getFinalTimeOrBuilder()

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

Breakpoint identifier, unique in the scope of the debuggee.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Breakpoint identifier, unique in the scope of the debuggee.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getIsFinalState()

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.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getLabelsMap()

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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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
Returns
Type Description
String

getLocation()

public SourceLocation getLocation()

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Returns
Type Description
SourceLocation

The location.

getLocationBuilder()

public SourceLocation.Builder getLocationBuilder()

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Returns
Type Description
SourceLocation.Builder

getLocationOrBuilder()

public SourceLocationOrBuilder getLocationOrBuilder()

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Returns
Type Description
SourceLocationOrBuilder

getLogLevel()

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;

Returns
Type Description
Breakpoint.LogLevel

The logLevel.

getLogLevelValue()

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.

getLogMessageFormat()

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.

getLogMessageFormatBytes()

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.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getStackFrames(int index)

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
Returns
Type Description
StackFrame

getStackFramesBuilder(int index)

public StackFrame.Builder getStackFramesBuilder(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.Builder

getStackFramesBuilderList()

public List<StackFrame.Builder> getStackFramesBuilderList()

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<Builder>

getStackFramesCount()

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

getStackFramesList()

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;

Returns
Type Description
List<StackFrame>

getStackFramesOrBuilder(int index)

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
Returns
Type Description
StackFrameOrBuilder

getStackFramesOrBuilderList()

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>

getStatus()

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 location
  • Field f not found in class C referring to condition

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

Returns
Type Description
StatusMessage

The status.

getStatusBuilder()

public StatusMessage.Builder getStatusBuilder()

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 location
  • Field f not found in class C referring to condition

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

Returns
Type Description
StatusMessage.Builder

getStatusOrBuilder()

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 location
  • Field f not found in class C referring to condition

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

Returns
Type Description
StatusMessageOrBuilder

getUserEmail()

public String getUserEmail()

E-mail address of the user that created this breakpoint

string user_email = 16;

Returns
Type Description
String

The userEmail.

getUserEmailBytes()

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.

getVariableTable(int index)

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
Returns
Type Description
Variable

getVariableTableBuilder(int index)

public Variable.Builder getVariableTableBuilder(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.Builder

getVariableTableBuilderList()

public List<Variable.Builder> getVariableTableBuilderList()

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<Builder>

getVariableTableCount()

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

getVariableTableList()

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;

Returns
Type Description
List<Variable>

getVariableTableOrBuilder(int index)

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
Returns
Type Description
VariableOrBuilder

getVariableTableOrBuilderList()

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>

hasCreateTime()

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.

hasFinalTime()

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.

hasLocation()

public boolean hasLocation()

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Returns
Type Description
boolean

Whether the location field is set.

hasStatus()

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 location
  • Field 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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Breakpoint.Builder mergeCreateTime(Timestamp value)

Time this breakpoint was created by the server in seconds resolution.

.google.protobuf.Timestamp create_time = 11;

Parameter
Name Description
value Timestamp
Returns
Type Description
Breakpoint.Builder

mergeFinalTime(Timestamp value)

public Breakpoint.Builder mergeFinalTime(Timestamp value)

Time this breakpoint was finalized as seen by the server in seconds resolution.

.google.protobuf.Timestamp final_time = 12;

Parameter
Name Description
value Timestamp
Returns
Type Description
Breakpoint.Builder

mergeFrom(Breakpoint other)

public Breakpoint.Builder mergeFrom(Breakpoint other)
Parameter
Name Description
other Breakpoint
Returns
Type Description
Breakpoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Breakpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Breakpoint.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Breakpoint.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Breakpoint.Builder
Overrides

mergeLocation(SourceLocation value)

public Breakpoint.Builder mergeLocation(SourceLocation value)

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Parameter
Name Description
value SourceLocation
Returns
Type Description
Breakpoint.Builder

mergeStatus(StatusMessage value)

public Breakpoint.Builder mergeStatus(StatusMessage value)

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 location
  • Field f not found in class C referring to condition

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

Parameter
Name Description
value StatusMessage
Returns
Type Description
Breakpoint.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Breakpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Breakpoint.Builder
Overrides

putAllLabels(Map<String,String> values)

public Breakpoint.Builder putAllLabels(Map<String,String> values)

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

map<string, string> labels = 17;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Breakpoint.Builder

putLabels(String key, String value)

public Breakpoint.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
Breakpoint.Builder

removeEvaluatedExpressions(int index)

public Breakpoint.Builder removeEvaluatedExpressions(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
Breakpoint.Builder

removeLabels(String key)

public Breakpoint.Builder removeLabels(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
Breakpoint.Builder

removeStackFrames(int index)

public Breakpoint.Builder removeStackFrames(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
Breakpoint.Builder

removeVariableTable(int index)

public Breakpoint.Builder removeVariableTable(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
Breakpoint.Builder

setAction(Breakpoint.Action value)

public Breakpoint.Builder setAction(Breakpoint.Action value)

Action that the agent should perform when the code at the breakpoint location is hit.

.google.devtools.clouddebugger.v2.Breakpoint.Action action = 13;

Parameter
Name Description
value Breakpoint.Action

The action to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setActionValue(int value)

public Breakpoint.Builder setActionValue(int value)

Action that the agent should perform when the code at the breakpoint location is hit.

.google.devtools.clouddebugger.v2.Breakpoint.Action action = 13;

Parameter
Name Description
value int

The enum numeric value on the wire for action to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setCondition(String value)

public Breakpoint.Builder setCondition(String value)

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;

Parameter
Name Description
value String

The condition to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setConditionBytes(ByteString value)

public Breakpoint.Builder setConditionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for condition to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Breakpoint.Builder setCreateTime(Timestamp value)

Time this breakpoint was created by the server in seconds resolution.

.google.protobuf.Timestamp create_time = 11;

Parameter
Name Description
value Timestamp
Returns
Type Description
Breakpoint.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Breakpoint.Builder setCreateTime(Timestamp.Builder builderForValue)

Time this breakpoint was created by the server in seconds resolution.

.google.protobuf.Timestamp create_time = 11;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Breakpoint.Builder

setEvaluatedExpressions(int index, Variable value)

public Breakpoint.Builder setEvaluatedExpressions(int index, Variable value)

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;

Parameters
Name Description
index int
value Variable
Returns
Type Description
Breakpoint.Builder

setEvaluatedExpressions(int index, Variable.Builder builderForValue)

public Breakpoint.Builder setEvaluatedExpressions(int index, Variable.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Variable.Builder
Returns
Type Description
Breakpoint.Builder

setExpressions(int index, String value)

public Breakpoint.Builder setExpressions(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The expressions to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Breakpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Breakpoint.Builder
Overrides

setFinalTime(Timestamp value)

public Breakpoint.Builder setFinalTime(Timestamp value)

Time this breakpoint was finalized as seen by the server in seconds resolution.

.google.protobuf.Timestamp final_time = 12;

Parameter
Name Description
value Timestamp
Returns
Type Description
Breakpoint.Builder

setFinalTime(Timestamp.Builder builderForValue)

public Breakpoint.Builder setFinalTime(Timestamp.Builder builderForValue)

Time this breakpoint was finalized as seen by the server in seconds resolution.

.google.protobuf.Timestamp final_time = 12;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Breakpoint.Builder

setId(String value)

public Breakpoint.Builder setId(String value)

Breakpoint identifier, unique in the scope of the debuggee.

string id = 1;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Breakpoint.Builder setIdBytes(ByteString value)

Breakpoint identifier, unique in the scope of the debuggee.

string id = 1;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setIsFinalState(boolean value)

public Breakpoint.Builder setIsFinalState(boolean value)

When true, indicates that this is a final result and the breakpoint state will not change from here on.

bool is_final_state = 5;

Parameter
Name Description
value boolean

The isFinalState to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setLocation(SourceLocation value)

public Breakpoint.Builder setLocation(SourceLocation value)

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Parameter
Name Description
value SourceLocation
Returns
Type Description
Breakpoint.Builder

setLocation(SourceLocation.Builder builderForValue)

public Breakpoint.Builder setLocation(SourceLocation.Builder builderForValue)

Breakpoint source location.

.google.devtools.clouddebugger.v2.SourceLocation location = 2;

Parameter
Name Description
builderForValue SourceLocation.Builder
Returns
Type Description
Breakpoint.Builder

setLogLevel(Breakpoint.LogLevel value)

public Breakpoint.Builder setLogLevel(Breakpoint.LogLevel value)

Indicates the severity of the log. Only relevant when action is LOG.

.google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;

Parameter
Name Description
value Breakpoint.LogLevel

The logLevel to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setLogLevelValue(int value)

public Breakpoint.Builder setLogLevelValue(int value)

Indicates the severity of the log. Only relevant when action is LOG.

.google.devtools.clouddebugger.v2.Breakpoint.LogLevel log_level = 15;

Parameter
Name Description
value int

The enum numeric value on the wire for logLevel to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setLogMessageFormat(String value)

public Breakpoint.Builder setLogMessageFormat(String value)

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;

Parameter
Name Description
value String

The logMessageFormat to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setLogMessageFormatBytes(ByteString value)

public Breakpoint.Builder setLogMessageFormatBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for logMessageFormat to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Breakpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Breakpoint.Builder
Overrides

setStackFrames(int index, StackFrame value)

public Breakpoint.Builder setStackFrames(int index, StackFrame value)

The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

Parameters
Name Description
index int
value StackFrame
Returns
Type Description
Breakpoint.Builder

setStackFrames(int index, StackFrame.Builder builderForValue)

public Breakpoint.Builder setStackFrames(int index, StackFrame.Builder builderForValue)

The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

repeated .google.devtools.clouddebugger.v2.StackFrame stack_frames = 7;

Parameters
Name Description
index int
builderForValue StackFrame.Builder
Returns
Type Description
Breakpoint.Builder

setStatus(StatusMessage value)

public Breakpoint.Builder setStatus(StatusMessage value)

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 location
  • Field f not found in class C referring to condition

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

Parameter
Name Description
value StatusMessage
Returns
Type Description
Breakpoint.Builder

setStatus(StatusMessage.Builder builderForValue)

public Breakpoint.Builder setStatus(StatusMessage.Builder builderForValue)

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 location
  • Field f not found in class C referring to condition

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

Parameter
Name Description
builderForValue StatusMessage.Builder
Returns
Type Description
Breakpoint.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Breakpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Breakpoint.Builder
Overrides

setUserEmail(String value)

public Breakpoint.Builder setUserEmail(String value)

E-mail address of the user that created this breakpoint

string user_email = 16;

Parameter
Name Description
value String

The userEmail to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setUserEmailBytes(ByteString value)

public Breakpoint.Builder setUserEmailBytes(ByteString value)

E-mail address of the user that created this breakpoint

string user_email = 16;

Parameter
Name Description
value ByteString

The bytes for userEmail to set.

Returns
Type Description
Breakpoint.Builder

This builder for chaining.

setVariableTable(int index, Variable value)

public Breakpoint.Builder setVariableTable(int index, Variable value)

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;

Parameters
Name Description
index int
value Variable
Returns
Type Description
Breakpoint.Builder

setVariableTable(int index, Variable.Builder builderForValue)

public Breakpoint.Builder setVariableTable(int index, Variable.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Variable.Builder
Returns
Type Description
Breakpoint.Builder