org.opendaylight.p4plugin.p4info.proto

Interface PreambleOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Preamble, Preamble.Builder

public interface PreambleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAlias() an alias for the P4 object, probably shorter than its name.
com.google.protobuf.ByteString	getAliasBytes() an alias for the P4 object, probably shorter than its name.
String	getAnnotations(int index) repeated string annotations = 4;
com.google.protobuf.ByteString	getAnnotationsBytes(int index) repeated string annotations = 4;
int	getAnnotationsCount() repeated string annotations = 4;
List<String>	getAnnotationsList() repeated string annotations = 4;
int	getId() ids share the same number-space; e.g.
String	getName() fully qualified name of the P4 object, e.g.
com.google.protobuf.ByteString	getNameBytes() fully qualified name of the P4 object, e.g.

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

getId

int getId()

 ids share the same number-space; e.g. table ids cannot overlap with counter
 ids. Even though this is irrelevant to this proto definition, the ids are
 allocated in such a way that it is possible based on an id to deduce the
 resource type (e.g. table, action, counter, ...). This means that code
 using these ids can detect if the wrong resource type is used
 somewhere. This also means that ids of different types can be mixed
 (e.g. direct resource list for a table) without ambiguity. Note that id 0
 is reserved and means "invalid id".
 

uint32 id = 1;

getName

String getName()

 fully qualified name of the P4 object, e.g. c1.c2.ipv4_lpm
 

string name = 2;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 fully qualified name of the P4 object, e.g. c1.c2.ipv4_lpm
 

string name = 2;

getAlias

String getAlias()

 an alias for the P4 object, probably shorter than its name. The only
 constraint is for it to be unique with respect to other P4 objects of the
 same type. By default, the compiler uses the shortest suffix of the name
 that uniquely indentifies the object. For example if the P4 program
 contains two tables with names s.c1.t and s.c2.t, the default aliases will
 respectively be c1.t and c2.t. The P4 programmer may also override the
 default alias for any P4 object (TBD). When resolving a P4 object id, an
 application should be able to indiscriminately use the name or the alias.
 

string alias = 3;

getAliasBytes

com.google.protobuf.ByteString getAliasBytes()

 an alias for the P4 object, probably shorter than its name. The only
 constraint is for it to be unique with respect to other P4 objects of the
 same type. By default, the compiler uses the shortest suffix of the name
 that uniquely indentifies the object. For example if the P4 program
 contains two tables with names s.c1.t and s.c2.t, the default aliases will
 respectively be c1.t and c2.t. The P4 programmer may also override the
 default alias for any P4 object (TBD). When resolving a P4 object id, an
 application should be able to indiscriminately use the name or the alias.
 

string alias = 3;

getAnnotationsList

List<String> getAnnotationsList()

repeated string annotations = 4;

getAnnotationsCount

int getAnnotationsCount()

repeated string annotations = 4;

getAnnotations

String getAnnotations(int index)

repeated string annotations = 4;

getAnnotationsBytes

com.google.protobuf.ByteString getAnnotationsBytes(int index)

repeated string annotations = 4;