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 messagegoogle.cloud.networkmanagement.v1.Trace
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Network Management V1 Client - Class Trace (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/php/docs/reference/cloud-network-management/latest/V1.Trace)\n- [2.4.2](/php/docs/reference/cloud-network-management/2.4.2/V1.Trace)\n- [2.3.2](/php/docs/reference/cloud-network-management/2.3.2/V1.Trace)\n- [2.2.1](/php/docs/reference/cloud-network-management/2.2.1/V1.Trace)\n- [2.1.1](/php/docs/reference/cloud-network-management/2.1.1/V1.Trace)\n- [2.0.1](/php/docs/reference/cloud-network-management/2.0.1/V1.Trace)\n- [1.7.3](/php/docs/reference/cloud-network-management/1.7.3/V1.Trace)\n- [1.5.0](/php/docs/reference/cloud-network-management/1.5.0/V1.Trace)\n- [1.4.2](/php/docs/reference/cloud-network-management/1.4.2/V1.Trace)\n- [1.3.0](/php/docs/reference/cloud-network-management/1.3.0/V1.Trace)\n- [1.2.0](/php/docs/reference/cloud-network-management/1.2.0/V1.Trace)\n- [1.1.1](/php/docs/reference/cloud-network-management/1.1.1/V1.Trace)\n- [1.0.5](/php/docs/reference/cloud-network-management/1.0.5/V1.Trace) \nReference documentation and code samples for the Google Cloud Network Management V1 Client class Trace.\n\nTrace represents one simulated packet forwarding path.\n\n- Each trace contains multiple ordered steps.\n - Each step is in a particular state with associated configuration.\n - State is categorized as final or non-final states.\n - Each final state has a reason associated.\n - Each trace must end with a final state (the last step). `php\n |---------------------Trace----------------------|\n Step1(State) Step2(State) --- StepN(State(final))`\n\nGenerated from protobuf message `google.cloud.networkmanagement.v1.Trace`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ NetworkManagement \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEndpointInfo\n\nDerived from the source and destination endpoints definition specified by\nuser request, and validated by the data plane model.\n\nIf there are multiple traces starting from different source locations, then\nthe endpoint_info may be different between traces.\n\n### hasEndpointInfo\n\n### clearEndpointInfo\n\n### setEndpointInfo\n\nDerived from the source and destination endpoints definition specified by\nuser request, and validated by the data plane model.\n\nIf there are multiple traces starting from different source locations, then\nthe endpoint_info may be different between traces.\n\n### getSteps\n\nA trace of a test contains multiple steps from the initial state to the\nfinal state (delivered, dropped, forwarded, or aborted).\n\nThe steps are ordered by the processing sequence within the simulated\nnetwork state machine. It is critical to preserve the order of the steps\nand avoid reordering or sorting them.\n\n### setSteps\n\nA trace of a test contains multiple steps from the initial state to the\nfinal state (delivered, dropped, forwarded, or aborted).\n\nThe steps are ordered by the processing sequence within the simulated\nnetwork state machine. It is critical to preserve the order of the steps\nand avoid reordering or sorting them.\n\n### getForwardTraceId\n\nID of trace. For forward traces, this ID is unique for each trace. For\nreturn traces, it matches ID of associated forward trace. A single forward\ntrace can be associated with none, one or more than one return trace.\n\n### setForwardTraceId\n\nID of trace. For forward traces, this ID is unique for each trace. For\nreturn traces, it matches ID of associated forward trace. A single forward\ntrace can be associated with none, one or more than one return trace."]]
