Show / Hide Table of Contents

Class Breakpoint

------------------------------------------------------------------------------ ## Breakpoint (the resource) Represents the breakpoint specification, status and results.

Inheritance
object
Breakpoint
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudDebugger.v2.Data
Assembly: Google.Apis.CloudDebugger.v2.dll
Syntax
public class Breakpoint : IDirectResponseSchema

Properties

Action

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

Declaration
[JsonProperty("action")]
public virtual string Action { get; set; }
Property Value
Type Description
string

CanaryExpireTime

object representation of CanaryExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CanaryExpireTimeDateTimeOffset instead.")]
public virtual object CanaryExpireTime { get; set; }
Property Value
Type Description
object

CanaryExpireTimeDateTimeOffset

DateTimeOffset representation of CanaryExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CanaryExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CanaryExpireTimeRaw

The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state.

Declaration
[JsonProperty("canaryExpireTime")]
public virtual string CanaryExpireTimeRaw { get; set; }
Property Value
Type Description
string

Condition

Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.

Declaration
[JsonProperty("condition")]
public virtual string Condition { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EvaluatedExpressions

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.

Declaration
[JsonProperty("evaluatedExpressions")]
public virtual IList<Variable> EvaluatedExpressions { get; set; }
Property Value
Type Description
IList<Variable>

Expressions

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.

Declaration
[JsonProperty("expressions")]
public virtual IList<string> Expressions { get; set; }
Property Value
Type Description
IList<string>

FinalTime

object representation of FinalTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use FinalTimeDateTimeOffset instead.")]
public virtual object FinalTime { get; set; }
Property Value
Type Description
object

FinalTimeDateTimeOffset

DateTimeOffset representation of FinalTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? FinalTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

FinalTimeRaw

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

Declaration
[JsonProperty("finalTime")]
public virtual string FinalTimeRaw { get; set; }
Property Value
Type Description
string

Id

Breakpoint identifier, unique in the scope of the debuggee.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

IsFinalState

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

Declaration
[JsonProperty("isFinalState")]
public virtual bool? IsFinalState { get; set; }
Property Value
Type Description
bool?

Labels

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

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Location

Breakpoint source location.

Declaration
[JsonProperty("location")]
public virtual SourceLocation Location { get; set; }
Property Value
Type Description
SourceLocation

LogLevel

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

Declaration
[JsonProperty("logLevel")]
public virtual string LogLevel { get; set; }
Property Value
Type Description
string

LogMessageFormat

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

Declaration
[JsonProperty("logMessageFormat")]
public virtual string LogMessageFormat { get; set; }
Property Value
Type Description
string

StackFrames

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

Declaration
[JsonProperty("stackFrames")]
public virtual IList<StackFrame> StackFrames { get; set; }
Property Value
Type Description
IList<StackFrame>

State

The current state of the breakpoint.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Status

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

Declaration
[JsonProperty("status")]
public virtual StatusMessage Status { get; set; }
Property Value
Type Description
StatusMessage

UserEmail

E-mail address of the user that created this breakpoint

Declaration
[JsonProperty("userEmail")]
public virtual string UserEmail { get; set; }
Property Value
Type Description
string

VariableTable

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.

Declaration
[JsonProperty("variableTable")]
public virtual IList<Variable> VariableTable { get; set; }
Property Value
Type Description
IList<Variable>

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX