# Stackdriver Debugger V2 Client - Class Breakpoint (1.9.5)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [1.9.5 (latest)](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.Breakpoint)
- [1.9.4](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/1.9.4/V2.Breakpoint)
- [1.8.8](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/1.8.8/V2.Breakpoint)
- [1.7.0](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/1.7.0/V2.Breakpoint)
- [1.6.4](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/1.6.4/V2.Breakpoint)
- [1.5.1](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/1.5.1/V2.Breakpoint)
- [1.4.16](https://docs.cloud.google.com/php/docs/reference/cloud-debugger/1.4.16/V2.Breakpoint)
Reference documentation and code samples for the Stackdriver Debugger V2 Client class Breakpoint.

Represents the breakpoint specification, status and results.

Generated from protobuf message `google.devtools.clouddebugger.v2.Breakpoint`

## Namespace

Google \\ Cloud \\ Debugger \\ V2

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ id` | `string` Breakpoint identifier, unique in the scope of the debuggee. |
| `↳ action` | `int` Action that the agent should perform when the code at the breakpoint location is hit. |
| `↳ location` | `https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.SourceLocation` Breakpoint source location. |
| `↳ condition` | `string` Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. |
| `↳ expressions` | `array` 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. |
| `↳ log_message_format` | `string` 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 ]`. |
| `↳ log_level` | `int` Indicates the severity of the log. Only relevant when action is `LOG`. |
| `↳ is_final_state` | `bool` When true, indicates that this is a final result and the breakpoint state will not change from here on. |
| `↳ create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Time this breakpoint was created by the server in seconds resolution. |
| `↳ final_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Time this breakpoint was finalized as seen by the server in seconds resolution. |
| `↳ user_email` | `string` E-mail address of the user that created this breakpoint |
| `↳ status` | `https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.StatusMessage` 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 |
| `↳ stack_frames` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.StackFrame>` The stack at breakpoint time, where stack_frames\[0\] represents the most recently entered function. |
| `↳ evaluated_expressions` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.Variable>` 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. |
| `↳ variable_table` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.Variable>` 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. |
| `↳ labels` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` A set of custom breakpoint properties, populated by the agent, to be displayed to the user. |

### getId

Breakpoint identifier, unique in the scope of the debuggee.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setId

Breakpoint identifier, unique in the scope of the debuggee.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAction

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setAction

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLocation

Breakpoint source location.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.SourceLocation|null` |   |

### hasLocation

### clearLocation

### setLocation

Breakpoint source location.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.SourceLocation` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setCondition

Condition that triggers the breakpoint.

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/RepeatedField` |   |

### setExpressions

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setLogMessageFormat

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLogLevel

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setLogLevel

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIsFinalState

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setIsFinalState

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreateTime

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFinalTime

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasFinalTime

### clearFinalTime

### setFinalTime

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getUserEmail

E-mail address of the user that created this breakpoint

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setUserEmail

E-mail address of the user that created this breakpoint

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.StatusMessage|null` |   |

### hasStatus

### clearStatus

### setStatus

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.StatusMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStackFrames

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/RepeatedField` |   |

### setStackFrames

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.StackFrame>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/RepeatedField` |   |

### setEvaluatedExpressions

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.Variable>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/RepeatedField` |   |

### setVariableTable

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-debugger/latest/V2.Variable>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLabels

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setLabels

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |