Reference documentation and code samples for the Google Cloud Network Management V1 Client class Trace.
Trace represents one simulated packet forwarding path.
- Each trace contains multiple ordered steps.
- Each step is in a particular state with associated configuration.
- State is categorized as final or non-final states.
- Each final state has a reason associated.
- Each trace must end with a final state (the last step).
php |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final))
Generated from protobuf message google.cloud.networkmanagement.v1.Trace
Namespace
Google \ Cloud \ NetworkManagement \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ endpoint_info |
EndpointInfo
Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. |
↳ steps |
array<Step>
A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. |
↳ forward_trace_id |
int
ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. |
getEndpointInfo
Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model.
If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.
| Returns | |
|---|---|
| Type | Description |
EndpointInfo|null |
|
hasEndpointInfo
clearEndpointInfo
setEndpointInfo
Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model.
If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.
| Parameter | |
|---|---|
| Name | Description |
var |
EndpointInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSteps
A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted).
The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSteps
A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted).
The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Step>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForwardTraceId
ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace.
| Returns | |
|---|---|
| Type | Description |
int |
|
setForwardTraceId
ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|