org.opendaylight.p4plugin.p4runtime.proto

Interface TableEntryOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TableEntry, TableEntry.Builder

public interface TableEntryOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
TableAction	getAction() .p4.v1.TableAction action = 3;
TableActionOrBuilder	getActionOrBuilder() .p4.v1.TableAction action = 3;
long	getControllerMetadata() Metadata (cookie) opaque to the target.
CounterData	getCounterData() .p4.v1.CounterData counter_data = 7;
CounterDataOrBuilder	getCounterDataOrBuilder() .p4.v1.CounterData counter_data = 7;
long	getIdleTimeoutNs() The TTL for the entry, in nanoseconds.
boolean	getIsDefaultAction() Set to true if the table entry is being used to update the non-const default action of the table.
FieldMatch	getMatch(int index) repeated .p4.v1.FieldMatch match = 2;
int	getMatchCount() repeated .p4.v1.FieldMatch match = 2;
List<FieldMatch>	getMatchList() repeated .p4.v1.FieldMatch match = 2;
FieldMatchOrBuilder	getMatchOrBuilder(int index) repeated .p4.v1.FieldMatch match = 2;
List<? extends FieldMatchOrBuilder>	getMatchOrBuilderList() repeated .p4.v1.FieldMatch match = 2;
MeterConfig	getMeterConfig() meter_config and counter_data are convenience fields that enable the controller to configure the direct resources associated with the table at the same time as a match-action entry is inserted or modified.
MeterConfigOrBuilder	getMeterConfigOrBuilder() meter_config and counter_data are convenience fields that enable the controller to configure the direct resources associated with the table at the same time as a match-action entry is inserted or modified.
int	getPriority() Should only be set if the match implies a TCAM lookup, i.e.
int	getTableId() uint32 table_id = 1;
TableEntry.IdleTimeout	getTimeSinceLastHit() Table wite: this field should be left unset.
TableEntry.IdleTimeoutOrBuilder	getTimeSinceLastHitOrBuilder() Table wite: this field should be left unset.
boolean	hasAction() .p4.v1.TableAction action = 3;
boolean	hasCounterData() .p4.v1.CounterData counter_data = 7;
boolean	hasMeterConfig() meter_config and counter_data are convenience fields that enable the controller to configure the direct resources associated with the table at the same time as a match-action entry is inserted or modified.
boolean	hasTimeSinceLastHit() Table wite: this field should be left unset.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTableId

int getTableId()

uint32 table_id = 1;

getMatchList

List<FieldMatch> getMatchList()

repeated .p4.v1.FieldMatch match = 2;

getMatch

FieldMatch getMatch(int index)

repeated .p4.v1.FieldMatch match = 2;

getMatchCount

int getMatchCount()

repeated .p4.v1.FieldMatch match = 2;

getMatchOrBuilderList

List<? extends FieldMatchOrBuilder> getMatchOrBuilderList()

repeated .p4.v1.FieldMatch match = 2;

getMatchOrBuilder

FieldMatchOrBuilder getMatchOrBuilder(int index)

repeated .p4.v1.FieldMatch match = 2;

hasAction

boolean hasAction()

.p4.v1.TableAction action = 3;

getAction

TableAction getAction()

.p4.v1.TableAction action = 3;

getActionOrBuilder

TableActionOrBuilder getActionOrBuilder()

.p4.v1.TableAction action = 3;

getPriority

int getPriority()

 Should only be set if the 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

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;

hasMeterConfig

boolean hasMeterConfig()

 meter_config and counter_data are convenience fields that enable the
 controller to configure the direct resources associated with the table at
 the same time as a match-action entry is inserted or modified.
 Table write:
   - If the table does not contain a direct resource, then setting the
     corresponding direct resource field in any table write operation will
     return an error.
   - When inserting a new table entry, leaving these fields unset means that
     the direct resources of this table (if any) will assume default values.
     For counters, the default value is 0, and for meters, the default value
     is always green.
   - When updating a table entry, leaving these fields unset means that the
     direct resources (if any) will not be updated.
 Table read:
   - If the table does not contain a direct resource, then the corresponding
     field will not be set in the read table entry.
   - If the meter_config field has default value, it will not be set in the
     read table entry.
   - The counter_data field will always be set in a read table entry if the
     table contains a direct counter.
 

.p4.v1.MeterConfig meter_config = 6;

getMeterConfig

MeterConfig getMeterConfig()

 meter_config and counter_data are convenience fields that enable the
 controller to configure the direct resources associated with the table at
 the same time as a match-action entry is inserted or modified.
 Table write:
   - If the table does not contain a direct resource, then setting the
     corresponding direct resource field in any table write operation will
     return an error.
   - When inserting a new table entry, leaving these fields unset means that
     the direct resources of this table (if any) will assume default values.
     For counters, the default value is 0, and for meters, the default value
     is always green.
   - When updating a table entry, leaving these fields unset means that the
     direct resources (if any) will not be updated.
 Table read:
   - If the table does not contain a direct resource, then the corresponding
     field will not be set in the read table entry.
   - If the meter_config field has default value, it will not be set in the
     read table entry.
   - The counter_data field will always be set in a read table entry if the
     table contains a direct counter.
 

.p4.v1.MeterConfig meter_config = 6;

getMeterConfigOrBuilder

MeterConfigOrBuilder getMeterConfigOrBuilder()

 meter_config and counter_data are convenience fields that enable the
 controller to configure the direct resources associated with the table at
 the same time as a match-action entry is inserted or modified.
 Table write:
   - If the table does not contain a direct resource, then setting the
     corresponding direct resource field in any table write operation will
     return an error.
   - When inserting a new table entry, leaving these fields unset means that
     the direct resources of this table (if any) will assume default values.
     For counters, the default value is 0, and for meters, the default value
     is always green.
   - When updating a table entry, leaving these fields unset means that the
     direct resources (if any) will not be updated.
 Table read:
   - If the table does not contain a direct resource, then the corresponding
     field will not be set in the read table entry.
   - If the meter_config field has default value, it will not be set in the
     read table entry.
   - The counter_data field will always be set in a read table entry if the
     table contains a direct counter.
 

.p4.v1.MeterConfig meter_config = 6;

hasCounterData

boolean hasCounterData()

.p4.v1.CounterData counter_data = 7;

getCounterData

CounterData getCounterData()

.p4.v1.CounterData counter_data = 7;

getCounterDataOrBuilder

CounterDataOrBuilder getCounterDataOrBuilder()

.p4.v1.CounterData counter_data = 7;

getIsDefaultAction

boolean getIsDefaultAction()

 Set to true if the table entry is being used to update the non-const
 default action of the table. If true, the "match" field must be empty and
 the "action" field must be populated with a valid direct action.
 

bool is_default_action = 8;

getIdleTimeoutNs

long getIdleTimeoutNs()

 The TTL for the entry, in nanoseconds. A value of 0 means that the table
 entry never "expires".
 

int64 idle_timeout_ns = 9;

hasTimeSinceLastHit

boolean hasTimeSinceLastHit()

 Table wite: this field should be left unset.
 Table read: if the table supports idle timeout and time_since_last_hit is
 set in the request, this field will be set in the response.
 

.p4.v1.TableEntry.IdleTimeout time_since_last_hit = 10;

getTimeSinceLastHit

TableEntry.IdleTimeout getTimeSinceLastHit()

 Table wite: this field should be left unset.
 Table read: if the table supports idle timeout and time_since_last_hit is
 set in the request, this field will be set in the response.
 

.p4.v1.TableEntry.IdleTimeout time_since_last_hit = 10;

getTimeSinceLastHitOrBuilder

TableEntry.IdleTimeoutOrBuilder getTimeSinceLastHitOrBuilder()

 Table wite: this field should be left unset.
 Table read: if the table supports idle timeout and time_since_last_hit is
 set in the request, this field will be set in the response.
 

.p4.v1.TableEntry.IdleTimeout time_since_last_hit = 10;