Package p4.config.v1
Interface P4InfoOuterClass.PreambleOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
P4InfoOuterClass.Preamble,P4InfoOuterClass.Preamble.Builder
- Enclosing class:
P4InfoOuterClass
public static interface P4InfoOuterClass.PreambleOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAlias()an alias (alternative name) for the P4 object, probably shorter than its fully qualified name.com.google.protobuf.ByteStringan alias (alternative name) for the P4 object, probably shorter than its fully qualified name.getAnnotationLocations(int index) Optional.intOptional.Optional.getAnnotationLocationsOrBuilder(int index) Optional.List<? extends P4Types.SourceLocationOrBuilder> Optional.getAnnotations(int index) repeated string annotations = 4;com.google.protobuf.ByteStringgetAnnotationsBytes(int index) repeated string annotations = 4;intrepeated string annotations = 4;repeated string annotations = 4;getDoc()Documentation of the entityDocumentation of the entityintgetId()ids share the same number-space; e.g.getName()fully qualified name of the P4 object, e.g.com.google.protobuf.ByteStringfully qualified name of the P4 object, e.g.getStructuredAnnotations(int index) repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6;intrepeated .p4.config.v1.StructuredAnnotation structured_annotations = 6;repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6;getStructuredAnnotationsOrBuilder(int index) repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6;List<? extends P4Types.StructuredAnnotationOrBuilder> repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6;booleanhasDoc()Documentation of the entityMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
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;- Returns:
- The id.
-
getName
String getName()fully qualified name of the P4 object, e.g. c1.c2.ipv4_lpm
string name = 2;- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()fully qualified name of the P4 object, e.g. c1.c2.ipv4_lpm
string name = 2;- Returns:
- The bytes for name.
-
getAlias
String getAlias()an alias (alternative name) for the P4 object, probably shorter than its fully qualified 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 identifies 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. In the future, the P4 programmer may also be able to override the default alias for any P4 object (TBD).
string alias = 3;- Returns:
- The alias.
-
getAliasBytes
com.google.protobuf.ByteString getAliasBytes()an alias (alternative name) for the P4 object, probably shorter than its fully qualified 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 identifies 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. In the future, the P4 programmer may also be able to override the default alias for any P4 object (TBD).
string alias = 3;- Returns:
- The bytes for alias.
-
getAnnotationsList
repeated string annotations = 4;- Returns:
- A list containing the annotations.
-
getAnnotationsCount
int getAnnotationsCount()repeated string annotations = 4;- Returns:
- The count of annotations.
-
getAnnotations
repeated string annotations = 4;- Parameters:
index- The index of the element to return.- Returns:
- The annotations at the given index.
-
getAnnotationsBytes
com.google.protobuf.ByteString getAnnotationsBytes(int index) repeated string annotations = 4;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the annotations at the given index.
-
getAnnotationLocationsList
List<P4Types.SourceLocation> getAnnotationLocationsList()Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.
repeated .p4.config.v1.SourceLocation annotation_locations = 7; -
getAnnotationLocations
Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.
repeated .p4.config.v1.SourceLocation annotation_locations = 7; -
getAnnotationLocationsCount
int getAnnotationLocationsCount()Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.
repeated .p4.config.v1.SourceLocation annotation_locations = 7; -
getAnnotationLocationsOrBuilderList
List<? extends P4Types.SourceLocationOrBuilder> getAnnotationLocationsOrBuilderList()Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.
repeated .p4.config.v1.SourceLocation annotation_locations = 7; -
getAnnotationLocationsOrBuilder
Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.
repeated .p4.config.v1.SourceLocation annotation_locations = 7; -
hasDoc
boolean hasDoc()Documentation of the entity
.p4.config.v1.Documentation doc = 5;- Returns:
- Whether the doc field is set.
-
getDoc
P4InfoOuterClass.Documentation getDoc()Documentation of the entity
.p4.config.v1.Documentation doc = 5;- Returns:
- The doc.
-
getDocOrBuilder
P4InfoOuterClass.DocumentationOrBuilder getDocOrBuilder()Documentation of the entity
.p4.config.v1.Documentation doc = 5; -
getStructuredAnnotationsList
List<P4Types.StructuredAnnotation> getStructuredAnnotationsList()repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6; -
getStructuredAnnotations
repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6; -
getStructuredAnnotationsCount
int getStructuredAnnotationsCount()repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6; -
getStructuredAnnotationsOrBuilderList
List<? extends P4Types.StructuredAnnotationOrBuilder> getStructuredAnnotationsOrBuilderList()repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6; -
getStructuredAnnotationsOrBuilder
repeated .p4.config.v1.StructuredAnnotation structured_annotations = 6;
-