Breakpoint (Cloud Debugger API v2 (Rev. 296) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.clouddebugger.v2.model.Breakpoint

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Breakpoint
extends com.google.api.client.json.GenericJson
```
------------------------------------------------------------------------------ ## Breakpoint (the resource) Represents the breakpoint specification, status and results.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Debugger API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Breakpoint()

Constructors
Constructor and Description
`Breakpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Breakpoint`	`clone()`
`java.lang.String`	`getAction()` Action that the agent should perform when the code at the breakpoint location is hit.
`java.lang.String`	`getCanaryExpireTime()` The deadline for the breakpoint to stay in CANARY_ACTIVE state.
`java.lang.String`	`getCondition()` Condition that triggers the breakpoint.
`java.lang.String`	`getCreateTime()` Time this breakpoint was created by the server in seconds resolution.
`java.util.List<Variable>`	`getEvaluatedExpressions()` Values of evaluated expressions at breakpoint time.
`java.util.List<java.lang.String>`	`getExpressions()` List of read-only expressions to evaluate at the breakpoint location.
`java.lang.String`	`getFinalTime()` Time this breakpoint was finalized as seen by the server in seconds resolution.
`java.lang.String`	`getId()` Breakpoint identifier, unique in the scope of the debuggee.
`java.lang.Boolean`	`getIsFinalState()` When true, indicates that this is a final result and the breakpoint state will not change from here on.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
`SourceLocation`	`getLocation()` Breakpoint source location.
`java.lang.String`	`getLogLevel()` Indicates the severity of the log.
`java.lang.String`	`getLogMessageFormat()` Only relevant when action is `LOG`.
`java.util.List<StackFrame>`	`getStackFrames()` The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
`java.lang.String`	`getState()` The current state of the breakpoint.
`StatusMessage`	`getStatus()` Breakpoint status.
`java.lang.String`	`getUserEmail()` E-mail address of the user that created this breakpoint
`java.util.List<Variable>`	`getVariableTable()` The `variable_table` exists to aid with computation, memory and network traffic optimization.
`Breakpoint`	`set(java.lang.String fieldName, java.lang.Object value)`
`Breakpoint`	`setAction(java.lang.String action)` Action that the agent should perform when the code at the breakpoint location is hit.
`Breakpoint`	`setCanaryExpireTime(java.lang.String canaryExpireTime)` The deadline for the breakpoint to stay in CANARY_ACTIVE state.
`Breakpoint`	`setCondition(java.lang.String condition)` Condition that triggers the breakpoint.
`Breakpoint`	`setCreateTime(java.lang.String createTime)` Time this breakpoint was created by the server in seconds resolution.
`Breakpoint`	`setEvaluatedExpressions(java.util.List<Variable> evaluatedExpressions)` Values of evaluated expressions at breakpoint time.
`Breakpoint`	`setExpressions(java.util.List<java.lang.String> expressions)` List of read-only expressions to evaluate at the breakpoint location.
`Breakpoint`	`setFinalTime(java.lang.String finalTime)` Time this breakpoint was finalized as seen by the server in seconds resolution.
`Breakpoint`	`setId(java.lang.String id)` Breakpoint identifier, unique in the scope of the debuggee.
`Breakpoint`	`setIsFinalState(java.lang.Boolean isFinalState)` When true, indicates that this is a final result and the breakpoint state will not change from here on.
`Breakpoint`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
`Breakpoint`	`setLocation(SourceLocation location)` Breakpoint source location.
`Breakpoint`	`setLogLevel(java.lang.String logLevel)` Indicates the severity of the log.
`Breakpoint`	`setLogMessageFormat(java.lang.String logMessageFormat)` Only relevant when action is `LOG`.
`Breakpoint`	`setStackFrames(java.util.List<StackFrame> stackFrames)` The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
`Breakpoint`	`setState(java.lang.String state)` The current state of the breakpoint.
`Breakpoint`	`setStatus(StatusMessage status)` Breakpoint status.
`Breakpoint`	`setUserEmail(java.lang.String userEmail)` E-mail address of the user that created this breakpoint
`Breakpoint`	`setVariableTable(java.util.List<Variable> variableTable)` The `variable_table` exists to aid with computation, memory and network traffic optimization.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Breakpoint
```
public Breakpoint()
```
- Method Detail
  - getAction
```
public java.lang.String getAction()
```
    Action that the agent should perform when the code at the breakpoint location is hit.
    
    Returns:
    
    value or null for none
  - setAction
```
public Breakpoint setAction(java.lang.String action)
```
    Action that the agent should perform when the code at the breakpoint location is hit.
    
    Parameters:
    
    action - action or null for none
  - getCanaryExpireTime
```
public java.lang.String getCanaryExpireTime()
```
    The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state.
    
    Returns:
    
    value or null for none
  - setCanaryExpireTime
```
public Breakpoint setCanaryExpireTime(java.lang.String canaryExpireTime)
```
    The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state.
    
    Parameters:
    
    canaryExpireTime - canaryExpireTime or null for none
  - getCondition
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setCondition
```
public Breakpoint setCondition(java.lang.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.
    
    Parameters:
    
    condition - condition or null for none
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    Time this breakpoint was created by the server in seconds resolution.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Breakpoint setCreateTime(java.lang.String createTime)
```
    Time this breakpoint was created by the server in seconds resolution.
    
    Parameters:
    
    createTime - createTime or null for none
  - getEvaluatedExpressions
```
public java.util.List<Variable> getEvaluatedExpressions()
```
    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.
    
    Returns:
    
    value or null for none
  - setEvaluatedExpressions
```
public Breakpoint setEvaluatedExpressions(java.util.List<Variable> 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.
    
    Parameters:
    
    evaluatedExpressions - evaluatedExpressions or null for none
  - getExpressions
```
public java.util.List<java.lang.String> getExpressions()
```
    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.
    
    Returns:
    
    value or null for none
  - setExpressions
```
public Breakpoint setExpressions(java.util.List<java.lang.String> 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.
    
    Parameters:
    
    expressions - expressions or null for none
  - getFinalTime
```
public java.lang.String getFinalTime()
```
    Time this breakpoint was finalized as seen by the server in seconds resolution.
    
    Returns:
    
    value or null for none
  - setFinalTime
```
public Breakpoint setFinalTime(java.lang.String finalTime)
```
    Time this breakpoint was finalized as seen by the server in seconds resolution.
    
    Parameters:
    
    finalTime - finalTime or null for none
  - getId
```
public java.lang.String getId()
```
    Breakpoint identifier, unique in the scope of the debuggee.
    
    Returns:
    
    value or null for none
  - setId
```
public Breakpoint setId(java.lang.String id)
```
    Breakpoint identifier, unique in the scope of the debuggee.
    
    Parameters:
    
    id - id or null for none
  - getIsFinalState
```
public java.lang.Boolean getIsFinalState()
```
    When true, indicates that this is a final result and the breakpoint state will not change from here on.
    
    Returns:
    
    value or null for none
  - setIsFinalState
```
public Breakpoint setIsFinalState(java.lang.Boolean isFinalState)
```
    When true, indicates that this is a final result and the breakpoint state will not change from here on.
    
    Parameters:
    
    isFinalState - isFinalState or null for none
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
    A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Breakpoint setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
    A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
    
    Parameters:
    
    labels - labels or null for none
  - getLocation
```
public SourceLocation getLocation()
```
    Breakpoint source location.
    
    Returns:
    
    value or null for none
  - setLocation
```
public Breakpoint setLocation(SourceLocation location)
```
    Breakpoint source location.
    
    Parameters:
    
    location - location or null for none
  - getLogLevel
```
public java.lang.String getLogLevel()
```
    Indicates the severity of the log. Only relevant when action is `LOG`.
    
    Returns:
    
    value or null for none
  - setLogLevel
```
public Breakpoint setLogLevel(java.lang.String logLevel)
```
    Indicates the severity of the log. Only relevant when action is `LOG`.
    
    Parameters:
    
    logLevel - logLevel or null for none
  - getLogMessageFormat
```
public java.lang.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 ]`.
    
    Returns:
    
    value or null for none
  - setLogMessageFormat
```
public Breakpoint setLogMessageFormat(java.lang.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 ]`.
    
    Parameters:
    
    logMessageFormat - logMessageFormat or null for none
  - getStackFrames
```
public java.util.List<StackFrame> getStackFrames()
```
    The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
    
    Returns:
    
    value or null for none
  - setStackFrames
```
public Breakpoint setStackFrames(java.util.List<StackFrame> stackFrames)
```
    The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
    
    Parameters:
    
    stackFrames - stackFrames or null for none
  - getState
```
public java.lang.String getState()
```
    The current state of the breakpoint.
    
    Returns:
    
    value or null for none
  - setState
```
public Breakpoint setState(java.lang.String state)
```
    The current state of the breakpoint.
    
    Parameters:
    
    state - state or null for none
  - 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
    
    Returns:
    
    value or null for none
  - setStatus
```
public Breakpoint setStatus(StatusMessage 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
    
    Parameters:
    
    status - status or null for none
  - getUserEmail
```
public java.lang.String getUserEmail()
```
    E-mail address of the user that created this breakpoint
    
    Returns:
    
    value or null for none
  - setUserEmail
```
public Breakpoint setUserEmail(java.lang.String userEmail)
```
    E-mail address of the user that created this breakpoint
    
    Parameters:
    
    userEmail - userEmail or null for none
  - getVariableTable
```
public java.util.List<Variable> getVariableTable()
```
    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.
    
    Returns:
    
    value or null for none
  - setVariableTable
```
public Breakpoint setVariableTable(java.util.List<Variable> 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.
    
    Parameters:
    
    variableTable - variableTable or null for none
  - set
```
public Breakpoint set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Breakpoint clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Debugger API v2 (revision 296)

Class Breakpoint

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Breakpoint

Method Detail

getAction

setAction

getCanaryExpireTime

setCanaryExpireTime

getCondition

setCondition

getCreateTime

setCreateTime

getEvaluatedExpressions

setEvaluatedExpressions

getExpressions

setExpressions

getFinalTime

setFinalTime

getId

setId

getIsFinalState

setIsFinalState

getLabels

setLabels

getLocation

setLocation

getLogLevel

setLogLevel

getLogMessageFormat

setLogMessageFormat

getStackFrames

setStackFrames

getState

setState

getStatus

setStatus

getUserEmail

setUserEmail

getVariableTable

setVariableTable

set

clone