Reference documentation and code samples for the Network Management V1 API class Google::Cloud::NetworkManagement::V1::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).
|---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final))
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#endpoint_info
def endpoint_info() -> ::Google::Cloud::NetworkManagement::V1::EndpointInfo
Returns
- (::Google::Cloud::NetworkManagement::V1::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.
#endpoint_info=
def endpoint_info=(value) -> ::Google::Cloud::NetworkManagement::V1::EndpointInfo
Parameter
- value (::Google::Cloud::NetworkManagement::V1::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.
Returns
- (::Google::Cloud::NetworkManagement::V1::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.
#forward_trace_id
def forward_trace_id() -> ::Integer
Returns
- (::Integer) — 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.
#forward_trace_id=
def forward_trace_id=(value) -> ::Integer
Parameter
- value (::Integer) — 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
- (::Integer) — 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.
#steps
def steps() -> ::Array<::Google::Cloud::NetworkManagement::V1::Step>
Returns
-
(::Array<::Google::Cloud::NetworkManagement::V1::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.
#steps=
def steps=(value) -> ::Array<::Google::Cloud::NetworkManagement::V1::Step>
Parameter
-
value (::Array<::Google::Cloud::NetworkManagement::V1::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.
Returns
-
(::Array<::Google::Cloud::NetworkManagement::V1::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.