org.opendaylight.p4plugin.p4runtime.proto

Class TableEntry.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

org.opendaylight.p4plugin.p4runtime.proto.TableEntry.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, TableEntryOrBuilder

Enclosing class:

TableEntry

public static final class TableEntry.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>
implements TableEntryOrBuilder

 From Section 11 of P4_14 spec:
 At run time, the table entry insert operation (not part of P4) must specify:
 - Values for each field specified in the reads entry.
 - The name of the action from the action_specification or the
   action_profile_specification and the parameters to be passed to the action
   function when it is called.
 

Protobuf type p4.TableEntry

Method Summary

Modifier and Type	Method and Description
TableEntry.Builder	addAllMatch(Iterable<? extends FieldMatch> values) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	addMatch(FieldMatch.Builder builderForValue) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	addMatch(FieldMatch value) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	addMatch(int index, FieldMatch.Builder builderForValue) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	addMatch(int index, FieldMatch value) repeated .p4.FieldMatch match = 2;
FieldMatch.Builder	addMatchBuilder() repeated .p4.FieldMatch match = 2;
FieldMatch.Builder	addMatchBuilder(int index) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TableEntry	build()
TableEntry	buildPartial()
TableEntry.Builder	clear()
TableEntry.Builder	clearAction() .p4.TableAction action = 3;
TableEntry.Builder	clearControllerMetadata() Metadata (cookie) opaque to the target.
TableEntry.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
TableEntry.Builder	clearMatch() repeated .p4.FieldMatch match = 2;
TableEntry.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
TableEntry.Builder	clearPriority() Ignored unless match implies a TCAM lookup, i.e.
TableEntry.Builder	clearTableId() uint32 table_id = 1;
TableEntry.Builder	clone()
TableAction	getAction() .p4.TableAction action = 3;
TableAction.Builder	getActionBuilder() .p4.TableAction action = 3;
TableActionOrBuilder	getActionOrBuilder() .p4.TableAction action = 3;
long	getControllerMetadata() Metadata (cookie) opaque to the target.
TableEntry	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
FieldMatch	getMatch(int index) repeated .p4.FieldMatch match = 2;
FieldMatch.Builder	getMatchBuilder(int index) repeated .p4.FieldMatch match = 2;
List<FieldMatch.Builder>	getMatchBuilderList() repeated .p4.FieldMatch match = 2;
int	getMatchCount() repeated .p4.FieldMatch match = 2;
List<FieldMatch>	getMatchList() repeated .p4.FieldMatch match = 2;
FieldMatchOrBuilder	getMatchOrBuilder(int index) repeated .p4.FieldMatch match = 2;
List<? extends FieldMatchOrBuilder>	getMatchOrBuilderList() repeated .p4.FieldMatch match = 2;
int	getPriority() Ignored unless match implies a TCAM lookup, i.e.
int	getTableId() uint32 table_id = 1;
boolean	hasAction() .p4.TableAction action = 3;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
TableEntry.Builder	mergeAction(TableAction value) .p4.TableAction action = 3;
TableEntry.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
TableEntry.Builder	mergeFrom(com.google.protobuf.Message other)
TableEntry.Builder	mergeFrom(TableEntry other)
TableEntry.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
TableEntry.Builder	removeMatch(int index) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	setAction(TableAction.Builder builderForValue) .p4.TableAction action = 3;
TableEntry.Builder	setAction(TableAction value) .p4.TableAction action = 3;
TableEntry.Builder	setControllerMetadata(long value) Metadata (cookie) opaque to the target.
TableEntry.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TableEntry.Builder	setMatch(int index, FieldMatch.Builder builderForValue) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	setMatch(int index, FieldMatch value) repeated .p4.FieldMatch match = 2;
TableEntry.Builder	setPriority(int value) Ignored unless match implies a TCAM lookup, i.e.
TableEntry.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
TableEntry.Builder	setTableId(int value) uint32 table_id = 1;
TableEntry.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

clear

public TableEntry.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

getDefaultInstanceForType

public TableEntry getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public TableEntry build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public TableEntry buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public TableEntry.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

setField

public TableEntry.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

clearField

public TableEntry.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

clearOneof

public TableEntry.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

setRepeatedField

public TableEntry.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

addRepeatedField

public TableEntry.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

mergeFrom

public TableEntry.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TableEntry.Builder>

mergeFrom

public TableEntry.Builder mergeFrom(TableEntry other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

mergeFrom

public TableEntry.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TableEntry.Builder>

Throws:

IOException

getTableId

public int getTableId()

uint32 table_id = 1;

Specified by:

getTableId in interface TableEntryOrBuilder

setTableId

public TableEntry.Builder setTableId(int value)

uint32 table_id = 1;

clearTableId

public TableEntry.Builder clearTableId()

uint32 table_id = 1;

getMatchList

public List<FieldMatch> getMatchList()

repeated .p4.FieldMatch match = 2;

Specified by:

getMatchList in interface TableEntryOrBuilder

getMatchCount

public int getMatchCount()

repeated .p4.FieldMatch match = 2;

Specified by:

getMatchCount in interface TableEntryOrBuilder

getMatch

public FieldMatch getMatch(int index)

repeated .p4.FieldMatch match = 2;

Specified by:

getMatch in interface TableEntryOrBuilder

setMatch

public TableEntry.Builder setMatch(int index,
                                   FieldMatch value)

repeated .p4.FieldMatch match = 2;

setMatch

public TableEntry.Builder setMatch(int index,
                                   FieldMatch.Builder builderForValue)

repeated .p4.FieldMatch match = 2;

addMatch

public TableEntry.Builder addMatch(FieldMatch value)

repeated .p4.FieldMatch match = 2;

addMatch

public TableEntry.Builder addMatch(int index,
                                   FieldMatch value)

repeated .p4.FieldMatch match = 2;

addMatch

public TableEntry.Builder addMatch(FieldMatch.Builder builderForValue)

repeated .p4.FieldMatch match = 2;

addMatch

public TableEntry.Builder addMatch(int index,
                                   FieldMatch.Builder builderForValue)

repeated .p4.FieldMatch match = 2;

addAllMatch

public TableEntry.Builder addAllMatch(Iterable<? extends FieldMatch> values)

repeated .p4.FieldMatch match = 2;

clearMatch

public TableEntry.Builder clearMatch()

repeated .p4.FieldMatch match = 2;

removeMatch

public TableEntry.Builder removeMatch(int index)

repeated .p4.FieldMatch match = 2;

getMatchBuilder

public FieldMatch.Builder getMatchBuilder(int index)

repeated .p4.FieldMatch match = 2;

getMatchOrBuilder

public FieldMatchOrBuilder getMatchOrBuilder(int index)

repeated .p4.FieldMatch match = 2;

Specified by:

getMatchOrBuilder in interface TableEntryOrBuilder

getMatchOrBuilderList

public List<? extends FieldMatchOrBuilder> getMatchOrBuilderList()

repeated .p4.FieldMatch match = 2;

Specified by:

getMatchOrBuilderList in interface TableEntryOrBuilder

addMatchBuilder

public FieldMatch.Builder addMatchBuilder()

repeated .p4.FieldMatch match = 2;

addMatchBuilder

public FieldMatch.Builder addMatchBuilder(int index)

repeated .p4.FieldMatch match = 2;

getMatchBuilderList

public List<FieldMatch.Builder> getMatchBuilderList()

repeated .p4.FieldMatch match = 2;

hasAction

public boolean hasAction()

.p4.TableAction action = 3;

Specified by:

hasAction in interface TableEntryOrBuilder

getAction

public TableAction getAction()

.p4.TableAction action = 3;

Specified by:

getAction in interface TableEntryOrBuilder

setAction

public TableEntry.Builder setAction(TableAction value)

.p4.TableAction action = 3;

setAction

public TableEntry.Builder setAction(TableAction.Builder builderForValue)

.p4.TableAction action = 3;

mergeAction

public TableEntry.Builder mergeAction(TableAction value)

.p4.TableAction action = 3;

clearAction

public TableEntry.Builder clearAction()

.p4.TableAction action = 3;

getActionBuilder

public TableAction.Builder getActionBuilder()

.p4.TableAction action = 3;

getActionOrBuilder

public TableActionOrBuilder getActionOrBuilder()

.p4.TableAction action = 3;

Specified by:

getActionOrBuilder in interface TableEntryOrBuilder

getPriority

public int getPriority()

 Ignored unless match implies a TCAM lookup, i.e. at least one of the
 match fields is Ternary or Range.
 A higher number indicates higher priority.
 Only the highest priority entry that matches the packet must be selected.
 Given an existing entry with prority k, if the controller tries to insert
 or modify another entry with priority k such that a packet may match both
 entries, an error is returned. This will be the case if the overlap is
 strict (entries are identical) or not.
 In the future, if there is a use-case, a table-level annotation may be 
 introduced to make the overlap check non-strict. In that case, if there
 are multiple matching entries with the same highest priority, the selected
 entry will be explicitly undefined.
 

int32 priority = 4;

Specified by:

getPriority in interface TableEntryOrBuilder

setPriority

public TableEntry.Builder setPriority(int value)

 Ignored unless match implies a TCAM lookup, i.e. at least one of the
 match fields is Ternary or Range.
 A higher number indicates higher priority.
 Only the highest priority entry that matches the packet must be selected.
 Given an existing entry with prority k, if the controller tries to insert
 or modify another entry with priority k such that a packet may match both
 entries, an error is returned. This will be the case if the overlap is
 strict (entries are identical) or not.
 In the future, if there is a use-case, a table-level annotation may be 
 introduced to make the overlap check non-strict. In that case, if there
 are multiple matching entries with the same highest priority, the selected
 entry will be explicitly undefined.
 

int32 priority = 4;

clearPriority

public TableEntry.Builder clearPriority()

 Ignored unless match implies a TCAM lookup, i.e. at least one of the
 match fields is Ternary or Range.
 A higher number indicates higher priority.
 Only the highest priority entry that matches the packet must be selected.
 Given an existing entry with prority k, if the controller tries to insert
 or modify another entry with priority k such that a packet may match both
 entries, an error is returned. This will be the case if the overlap is
 strict (entries are identical) or not.
 In the future, if there is a use-case, a table-level annotation may be 
 introduced to make the overlap check non-strict. In that case, if there
 are multiple matching entries with the same highest priority, the selected
 entry will be explicitly undefined.
 

int32 priority = 4;

getControllerMetadata

public long getControllerMetadata()

 Metadata (cookie) opaque to the target. There is no requirement of where
 this is stored, as long as it is returned with the rest of the entry in
 a Read RPC.
 

uint64 controller_metadata = 5;

Specified by:

getControllerMetadata in interface TableEntryOrBuilder

setControllerMetadata

public TableEntry.Builder setControllerMetadata(long value)

 Metadata (cookie) opaque to the target. There is no requirement of where
 this is stored, as long as it is returned with the rest of the entry in
 a Read RPC.
 

uint64 controller_metadata = 5;

clearControllerMetadata

public TableEntry.Builder clearControllerMetadata()

 Metadata (cookie) opaque to the target. There is no requirement of where
 this is stored, as long as it is returned with the rest of the entry in
 a Read RPC.
 

uint64 controller_metadata = 5;

setUnknownFields

public final TableEntry.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>

mergeUnknownFields

public final TableEntry.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TableEntry.Builder>