Preamble.Builder (p4plugin:aggregator 0.1.5-SNAPSHOT API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Preamble.Builder>
    - - org.opendaylight.p4plugin.p4info.proto.Preamble.Builder

All Implemented Interfaces:

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

Enclosing class:

Preamble
```
public static final class Preamble.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Preamble.Builder>
implements PreambleOrBuilder
```
Protobuf type p4.config.Preamble

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Preamble.Builder`	`addAllAnnotations(Iterable<String> values)` `repeated string annotations = 4;`
`Preamble.Builder`	`addAnnotations(String value)` `repeated string annotations = 4;`
`Preamble.Builder`	`addAnnotationsBytes(com.google.protobuf.ByteString value)` `repeated string annotations = 4;`
`Preamble.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Preamble`	`build()`
`Preamble`	`buildPartial()`
`Preamble.Builder`	`clear()`
`Preamble.Builder`	`clearAlias()` an alias for the P4 object, probably shorter than its name.
`Preamble.Builder`	`clearAnnotations()` `repeated string annotations = 4;`
`Preamble.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Preamble.Builder`	`clearId()` ids share the same number-space; e.g.
`Preamble.Builder`	`clearName()` fully qualified name of the P4 object, e.g.
`Preamble.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Preamble.Builder`	`clone()`
`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;`
`com.google.protobuf.ProtocolStringList`	`getAnnotationsList()` `repeated string annotations = 4;`
`Preamble`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Preamble.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Preamble.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Preamble.Builder`	`mergeFrom(Preamble other)`
`Preamble.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Preamble.Builder`	`setAlias(String value)` an alias for the P4 object, probably shorter than its name.
`Preamble.Builder`	`setAliasBytes(com.google.protobuf.ByteString value)` an alias for the P4 object, probably shorter than its name.
`Preamble.Builder`	`setAnnotations(int index, String value)` `repeated string annotations = 4;`
`Preamble.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Preamble.Builder`	`setId(int value)` ids share the same number-space; e.g.
`Preamble.Builder`	`setName(String value)` fully qualified name of the P4 object, e.g.
`Preamble.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` fully qualified name of the P4 object, e.g.
`Preamble.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Preamble.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<Preamble.Builder>

clear
```
public Preamble.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<Preamble.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<Preamble.Builder>

getDefaultInstanceForType
```
public Preamble getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Preamble build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public Preamble buildPartial()
```
Specified by:

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

Specified by:

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

clone
```
public Preamble.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<Preamble.Builder>

setField

public Preamble.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<Preamble.Builder>

clearField
```
public Preamble.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<Preamble.Builder>

clearOneof
```
public Preamble.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<Preamble.Builder>

setRepeatedField

public Preamble.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<Preamble.Builder>

addRepeatedField

public Preamble.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<Preamble.Builder>

mergeFrom
```
public Preamble.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<Preamble.Builder>

mergeFrom

public Preamble.Builder mergeFrom(Preamble other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public Preamble.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<Preamble.Builder>

Throws:

IOException

getId

public 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;

Specified by:: getId in interface PreambleOrBuilder

setId

public Preamble.Builder setId(int value)

 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;

clearId

public Preamble.Builder clearId()

 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

public String getName()

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

string name = 2;

Specified by:: getName in interface PreambleOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

string name = 2;

Specified by:: getNameBytes in interface PreambleOrBuilder

setName

public Preamble.Builder setName(String value)

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

string name = 2;

clearName

public Preamble.Builder clearName()

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

string name = 2;

setNameBytes

public Preamble.Builder setNameBytes(com.google.protobuf.ByteString value)

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

string name = 2;

getAlias

public 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;

Specified by:: getAlias in interface PreambleOrBuilder

getAliasBytes

public 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;

Specified by:: getAliasBytes in interface PreambleOrBuilder

setAlias

public Preamble.Builder setAlias(String value)

 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;

clearAlias

public Preamble.Builder clearAlias()

 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;

setAliasBytes

public Preamble.Builder setAliasBytes(com.google.protobuf.ByteString value)

 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
```
public com.google.protobuf.ProtocolStringList getAnnotationsList()
```
repeated string annotations = 4;

Specified by:

getAnnotationsList in interface PreambleOrBuilder

getAnnotationsCount
```
public int getAnnotationsCount()
```
repeated string annotations = 4;

Specified by:

getAnnotationsCount in interface PreambleOrBuilder

getAnnotations
```
public String getAnnotations(int index)
```
repeated string annotations = 4;

Specified by:

getAnnotations in interface PreambleOrBuilder

getAnnotationsBytes
```
public com.google.protobuf.ByteString getAnnotationsBytes(int index)
```
repeated string annotations = 4;

Specified by:

getAnnotationsBytes in interface PreambleOrBuilder