Class Trace.Builder (1.45.0) 

public static final class Trace.Builder extends GeneratedMessageV3.Builder<Trace.Builder> 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.v1.Trace

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Trace.Builder

Implements

TraceOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllSteps(Iterable<? extends Step> values)

public Trace.Builder addAllSteps(Iterable<? extends Step> values)

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.v1.Step steps = 2;

Parameter
Name Description
values Iterable<? extends com.google.cloud.networkmanagement.v1.Step>
Returns
Type Description
Trace.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Trace.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Trace.Builder
Overrides

addSteps(Step value)

public Trace.Builder addSteps(Step value)

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.v1.Step steps = 2;

Parameter
Name Description
value Step
Returns
Type Description
Trace.Builder

addSteps(Step.Builder builderForValue)

public Trace.Builder addSteps(Step.Builder builderForValue)

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.v1.Step steps = 2;

Parameter
Name Description
builderForValue Step.Builder
Returns
Type Description
Trace.Builder

addSteps(int index, Step value)

public Trace.Builder addSteps(int index, Step value)

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.v1.Step steps = 2;

Parameters
Name Description
index int
value Step
Returns
Type Description
Trace.Builder

addSteps(int index, Step.Builder builderForValue)

public Trace.Builder addSteps(int index, Step.Builder builderForValue)

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.v1.Step steps = 2;

Parameters
Name Description
index int
builderForValue Step.Builder
Returns
Type Description
Trace.Builder

addStepsBuilder()

public Step.Builder addStepsBuilder()

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.v1.Step steps = 2;

Returns
Type Description
Step.Builder

addStepsBuilder(int index)

public Step.Builder addStepsBuilder(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.v1.Step steps = 2;

Parameter
Name Description
index int
Returns
Type Description
Step.Builder

build()

public Trace build()
Returns
Type Description
Trace

buildPartial()

public Trace buildPartial()
Returns
Type Description
Trace

clear()

public Trace.Builder clear()
Returns
Type Description
Trace.Builder
Overrides

clearEndpointInfo()

public Trace.Builder clearEndpointInfo()

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.v1.EndpointInfo endpoint_info = 1;

Returns
Type Description
Trace.Builder

clearField(Descriptors.FieldDescriptor field)

public Trace.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Trace.Builder
Overrides

clearForwardTraceId()

public Trace.Builder clearForwardTraceId()

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
Trace.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Trace.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Trace.Builder
Overrides

clearSteps()

public Trace.Builder clearSteps()

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.v1.Step steps = 2;

Returns
Type Description
Trace.Builder

clone()

public Trace.Builder clone()
Returns
Type Description
Trace.Builder
Overrides

getDefaultInstanceForType()

public Trace getDefaultInstanceForType()
Returns
Type Description
Trace

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.v1.EndpointInfo endpoint_info = 1;

Returns
Type Description
EndpointInfo

The endpointInfo.

getEndpointInfoBuilder()

public EndpointInfo.Builder getEndpointInfoBuilder()

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.v1.EndpointInfo endpoint_info = 1;

Returns
Type Description
EndpointInfo.Builder

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.v1.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.

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.v1.Step steps = 2;

Parameter
Name Description
index int
Returns
Type Description
Step

getStepsBuilder(int index)

public Step.Builder getStepsBuilder(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.v1.Step steps = 2;

Parameter
Name Description
index int
Returns
Type Description
Step.Builder

getStepsBuilderList()

public List<Step.Builder> getStepsBuilderList()

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.v1.Step steps = 2;

Returns
Type Description
List<Builder>

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.v1.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.v1.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.v1.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.v1.Step steps = 2;

Returns
Type Description
List<? extends com.google.cloud.networkmanagement.v1.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.v1.EndpointInfo endpoint_info = 1;

Returns
Type Description
boolean

Whether the endpointInfo field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndpointInfo(EndpointInfo value)

public Trace.Builder mergeEndpointInfo(EndpointInfo value)

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.v1.EndpointInfo endpoint_info = 1;

Parameter
Name Description
value EndpointInfo
Returns
Type Description
Trace.Builder

mergeFrom(Trace other)

public Trace.Builder mergeFrom(Trace other)
Parameter
Name Description
other Trace
Returns
Type Description
Trace.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Trace.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trace.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Trace.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Trace.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Trace.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Trace.Builder
Overrides

removeSteps(int index)

public Trace.Builder removeSteps(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.v1.Step steps = 2;

Parameter
Name Description
index int
Returns
Type Description
Trace.Builder

setEndpointInfo(EndpointInfo value)

public Trace.Builder setEndpointInfo(EndpointInfo value)

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.v1.EndpointInfo endpoint_info = 1;

Parameter
Name Description
value EndpointInfo
Returns
Type Description
Trace.Builder

setEndpointInfo(EndpointInfo.Builder builderForValue)

public Trace.Builder setEndpointInfo(EndpointInfo.Builder builderForValue)

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.v1.EndpointInfo endpoint_info = 1;

Parameter
Name Description
builderForValue EndpointInfo.Builder
Returns
Type Description
Trace.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Trace.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Trace.Builder
Overrides

setForwardTraceId(int value)

public Trace.Builder setForwardTraceId(int value)

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;

Parameter
Name Description
value int

The forwardTraceId to set.
Returns
Type Description
Trace.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Trace.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Trace.Builder
Overrides

setSteps(int index, Step value)

public Trace.Builder setSteps(int index, Step value)

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.v1.Step steps = 2;

Parameters
Name Description
index int
value Step
Returns
Type Description
Trace.Builder

setSteps(int index, Step.Builder builderForValue)

public Trace.Builder setSteps(int index, Step.Builder builderForValue)

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.v1.Step steps = 2;

Parameters
Name Description
index int
builderForValue Step.Builder
Returns
Type Description
Trace.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Trace.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Trace.Builder
Overrides