Class Trace (1.50.0)

public final class Trace extends GeneratedMessageV3 implements TraceOrBuilder

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). <code><code> |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) </code></code>

Protobuf type google.cloud.networkmanagement.v1beta1.Trace

Implements

TraceOrBuilder

Static Fields

ENDPOINT_INFO_FIELD_NUMBER

public static final int ENDPOINT_INFO_FIELD_NUMBER
Field Value
Type Description
int

FORWARD_TRACE_ID_FIELD_NUMBER

public static final int FORWARD_TRACE_ID_FIELD_NUMBER
Field Value
Type Description
int

STEPS_FIELD_NUMBER

public static final int STEPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Trace getDefaultInstance()
Returns
Type Description
Trace

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Trace.Builder newBuilder()
Returns
Type Description
Trace.Builder

newBuilder(Trace prototype)

public static Trace.Builder newBuilder(Trace prototype)
Parameter
Name Description
prototype Trace
Returns
Type Description
Trace.Builder

parseDelimitedFrom(InputStream input)

public static Trace parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Trace
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Trace parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Trace parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Trace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Trace parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Trace parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Trace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Trace parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Trace parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Trace
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Trace parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Trace parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Trace
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Trace parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Trace parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Trace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Trace parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Trace> parser()
Returns
Type Description
Parser<Trace>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Trace getDefaultInstanceForType()
Returns
Type Description
Trace

getEndpointInfo()

public EndpointInfo 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.

.google.cloud.networkmanagement.v1beta1.EndpointInfo endpoint_info = 1;

Returns
Type Description
EndpointInfo

The endpointInfo.

getEndpointInfoOrBuilder()

public EndpointInfoOrBuilder getEndpointInfoOrBuilder()

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.

.google.cloud.networkmanagement.v1beta1.EndpointInfo endpoint_info = 1;

Returns
Type Description
EndpointInfoOrBuilder

getForwardTraceId()

public int 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.

int32 forward_trace_id = 4;

Returns
Type Description
int

The forwardTraceId.

getParserForType()

public Parser<Trace> getParserForType()
Returns
Type Description
Parser<Trace>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSteps(int index)

public Step getSteps(int index)

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.

repeated .google.cloud.networkmanagement.v1beta1.Step steps = 2;

Parameter
Name Description
index int
Returns
Type Description
Step

getStepsCount()

public int getStepsCount()

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.

repeated .google.cloud.networkmanagement.v1beta1.Step steps = 2;

Returns
Type Description
int

getStepsList()

public List<Step> getStepsList()

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.

repeated .google.cloud.networkmanagement.v1beta1.Step steps = 2;

Returns
Type Description
List<Step>

getStepsOrBuilder(int index)

public StepOrBuilder getStepsOrBuilder(int index)

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.

repeated .google.cloud.networkmanagement.v1beta1.Step steps = 2;

Parameter
Name Description
index int
Returns
Type Description
StepOrBuilder

getStepsOrBuilderList()

public List<? extends StepOrBuilder> getStepsOrBuilderList()

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.

repeated .google.cloud.networkmanagement.v1beta1.Step steps = 2;

Returns
Type Description
List<? extends com.google.cloud.networkmanagement.v1beta1.StepOrBuilder>

hasEndpointInfo()

public boolean hasEndpointInfo()

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.

.google.cloud.networkmanagement.v1beta1.EndpointInfo endpoint_info = 1;

Returns
Type Description
boolean

Whether the endpointInfo field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Trace.Builder newBuilderForType()
Returns
Type Description
Trace.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Trace.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Trace.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Trace.Builder toBuilder()
Returns
Type Description
Trace.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException