org.opendaylight.p4plugin.gnmi.proto

Class SubscriptionList

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.opendaylight.p4plugin.gnmi.proto.SubscriptionList

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SubscriptionListOrBuilder

public final class SubscriptionList
extends com.google.protobuf.GeneratedMessageV3
implements SubscriptionListOrBuilder

 SubscriptionList is used within a Subscribe message to specify the list of
 paths that the client wishes to subscribe to. The message consists of a
 list of (possibly prefixed) paths, and options that relate to the
 subscription.
 Reference: gNMI Specification Section 3.5.1.2
 

Protobuf type gnmi.SubscriptionList

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionList.Builder SubscriptionList is used within a Subscribe message to specify the list of paths that the client wishes to subscribe to.
static class	SubscriptionList.Mode Mode of the subscription.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_AGGREGATION_FIELD_NUMBER
static int	ENCODING_FIELD_NUMBER
static int	MODE_FIELD_NUMBER
static int	PREFIX_FIELD_NUMBER
static int	QOS_FIELD_NUMBER
static int	SUBSCRIPTION_FIELD_NUMBER
static int	UPDATES_ONLY_FIELD_NUMBER
static int	USE_ALIASES_FIELD_NUMBER
static int	USE_MODELS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAllowAggregation() Whether elements of the schema that are marked as eligible for aggregation should be aggregated or not.
static SubscriptionList	getDefaultInstance()
SubscriptionList	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Encoding	getEncoding() The encoding that the target should use within the Notifications generated corresponding to the SubscriptionList.
int	getEncodingValue() The encoding that the target should use within the Notifications generated corresponding to the SubscriptionList.
SubscriptionList.Mode	getMode() .gnmi.SubscriptionList.Mode mode = 5;
int	getModeValue() .gnmi.SubscriptionList.Mode mode = 5;
com.google.protobuf.Parser<SubscriptionList>	getParserForType()
Path	getPrefix() Prefix used for paths.
PathOrBuilder	getPrefixOrBuilder() Prefix used for paths.
QOSMarking	getQos() DSCP marking to be used.
QOSMarkingOrBuilder	getQosOrBuilder() DSCP marking to be used.
int	getSerializedSize()
Subscription	getSubscription(int index) Set of subscriptions to create.
int	getSubscriptionCount() Set of subscriptions to create.
List<Subscription>	getSubscriptionList() Set of subscriptions to create.
SubscriptionOrBuilder	getSubscriptionOrBuilder(int index) Set of subscriptions to create.
List<? extends SubscriptionOrBuilder>	getSubscriptionOrBuilderList() Set of subscriptions to create.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	getUpdatesOnly() An optional field to specify that only updates to current state should be sent to a client.
boolean	getUseAliases() Whether target defined aliases are allowed within the subscription.
ModelData	getUseModels(int index) The set of schemas that define the elements of the data tree that should be sent by the target.
int	getUseModelsCount() The set of schemas that define the elements of the data tree that should be sent by the target.
List<ModelData>	getUseModelsList() The set of schemas that define the elements of the data tree that should be sent by the target.
ModelDataOrBuilder	getUseModelsOrBuilder(int index) The set of schemas that define the elements of the data tree that should be sent by the target.
List<? extends ModelDataOrBuilder>	getUseModelsOrBuilderList() The set of schemas that define the elements of the data tree that should be sent by the target.
int	hashCode()
boolean	hasPrefix() Prefix used for paths.
boolean	hasQos() DSCP marking to be used.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SubscriptionList.Builder	newBuilder()
static SubscriptionList.Builder	newBuilder(SubscriptionList prototype)
SubscriptionList.Builder	newBuilderForType()
protected SubscriptionList.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static SubscriptionList	parseDelimitedFrom(InputStream input)
static SubscriptionList	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubscriptionList	parseFrom(byte[] data)
static SubscriptionList	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubscriptionList	parseFrom(ByteBuffer data)
static SubscriptionList	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubscriptionList	parseFrom(com.google.protobuf.ByteString data)
static SubscriptionList	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubscriptionList	parseFrom(com.google.protobuf.CodedInputStream input)
static SubscriptionList	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubscriptionList	parseFrom(InputStream input)
static SubscriptionList	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SubscriptionList>	parser()
SubscriptionList.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PREFIX_FIELD_NUMBER

public static final int PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

USE_ALIASES_FIELD_NUMBER

public static final int USE_ALIASES_FIELD_NUMBER

See Also:

Constant Field Values

QOS_FIELD_NUMBER

public static final int QOS_FIELD_NUMBER

See Also:

Constant Field Values

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_AGGREGATION_FIELD_NUMBER

public static final int ALLOW_AGGREGATION_FIELD_NUMBER

See Also:

Constant Field Values

USE_MODELS_FIELD_NUMBER

public static final int USE_MODELS_FIELD_NUMBER

See Also:

Constant Field Values

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER

See Also:

Constant Field Values

UPDATES_ONLY_FIELD_NUMBER

public static final int UPDATES_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

hasPrefix

public boolean hasPrefix()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

hasPrefix in interface SubscriptionListOrBuilder

getPrefix

public Path getPrefix()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

getPrefix in interface SubscriptionListOrBuilder

getPrefixOrBuilder

public PathOrBuilder getPrefixOrBuilder()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

getPrefixOrBuilder in interface SubscriptionListOrBuilder

getSubscriptionList

public List<Subscription> getSubscriptionList()

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionList in interface SubscriptionListOrBuilder

getSubscriptionOrBuilderList

public List<? extends SubscriptionOrBuilder> getSubscriptionOrBuilderList()

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionOrBuilderList in interface SubscriptionListOrBuilder

getSubscriptionCount

public int getSubscriptionCount()

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionCount in interface SubscriptionListOrBuilder

getSubscription

public Subscription getSubscription(int index)

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscription in interface SubscriptionListOrBuilder

getSubscriptionOrBuilder

public SubscriptionOrBuilder getSubscriptionOrBuilder(int index)

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionOrBuilder in interface SubscriptionListOrBuilder

getUseAliases

public boolean getUseAliases()

 Whether target defined aliases are allowed within the subscription.
 

bool use_aliases = 3;

Specified by:

getUseAliases in interface SubscriptionListOrBuilder

hasQos

public boolean hasQos()

 DSCP marking to be used.
 

.gnmi.QOSMarking qos = 4;

Specified by:

hasQos in interface SubscriptionListOrBuilder

getQos

public QOSMarking getQos()

 DSCP marking to be used.
 

.gnmi.QOSMarking qos = 4;

Specified by:

getQos in interface SubscriptionListOrBuilder

getQosOrBuilder

public QOSMarkingOrBuilder getQosOrBuilder()

 DSCP marking to be used.
 

.gnmi.QOSMarking qos = 4;

Specified by:

getQosOrBuilder in interface SubscriptionListOrBuilder

getModeValue

public int getModeValue()

.gnmi.SubscriptionList.Mode mode = 5;

Specified by:

getModeValue in interface SubscriptionListOrBuilder

getMode

public SubscriptionList.Mode getMode()

.gnmi.SubscriptionList.Mode mode = 5;

Specified by:

getMode in interface SubscriptionListOrBuilder

getAllowAggregation

public boolean getAllowAggregation()

 Whether elements of the schema that are marked as eligible for aggregation
 should be aggregated or not.
 

bool allow_aggregation = 6;

Specified by:

getAllowAggregation in interface SubscriptionListOrBuilder

getUseModelsList

public List<ModelData> getUseModelsList()

 The set of schemas that define the elements of the data tree that should
 be sent by the target.
 

repeated .gnmi.ModelData use_models = 7;

Specified by:

getUseModelsList in interface SubscriptionListOrBuilder

getUseModelsOrBuilderList

public List<? extends ModelDataOrBuilder> getUseModelsOrBuilderList()

 The set of schemas that define the elements of the data tree that should
 be sent by the target.
 

repeated .gnmi.ModelData use_models = 7;

Specified by:

getUseModelsOrBuilderList in interface SubscriptionListOrBuilder

getUseModelsCount

public int getUseModelsCount()

 The set of schemas that define the elements of the data tree that should
 be sent by the target.
 

repeated .gnmi.ModelData use_models = 7;

Specified by:

getUseModelsCount in interface SubscriptionListOrBuilder

getUseModels

public ModelData getUseModels(int index)

 The set of schemas that define the elements of the data tree that should
 be sent by the target.
 

repeated .gnmi.ModelData use_models = 7;

Specified by:

getUseModels in interface SubscriptionListOrBuilder

getUseModelsOrBuilder

public ModelDataOrBuilder getUseModelsOrBuilder(int index)

 The set of schemas that define the elements of the data tree that should
 be sent by the target.
 

repeated .gnmi.ModelData use_models = 7;

Specified by:

getUseModelsOrBuilder in interface SubscriptionListOrBuilder

getEncodingValue

public int getEncodingValue()

 The encoding that the target should use within the Notifications generated
 corresponding to the SubscriptionList.
 

.gnmi.Encoding encoding = 8;

Specified by:

getEncodingValue in interface SubscriptionListOrBuilder

getEncoding

public Encoding getEncoding()

 The encoding that the target should use within the Notifications generated
 corresponding to the SubscriptionList.
 

.gnmi.Encoding encoding = 8;

Specified by:

getEncoding in interface SubscriptionListOrBuilder

getUpdatesOnly

public boolean getUpdatesOnly()

 An optional field to specify that only updates to current state should be
 sent to a client. If set, the initial state is not sent to the client but
 rather only the sync message followed by any subsequent updates to the
 current state. For ONCE and POLL modes, this causes the server to send only
 the sync message (Sec. 3.5.2.3).
 

bool updates_only = 9;

Specified by:

getUpdatesOnly in interface SubscriptionListOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SubscriptionList parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubscriptionList parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubscriptionList parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubscriptionList parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubscriptionList parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubscriptionList parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubscriptionList parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static SubscriptionList parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static SubscriptionList parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static SubscriptionList parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static SubscriptionList parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static SubscriptionList parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public SubscriptionList.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SubscriptionList.Builder newBuilder()

newBuilder

public static SubscriptionList.Builder newBuilder(SubscriptionList prototype)

toBuilder

public SubscriptionList.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SubscriptionList.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SubscriptionList getDefaultInstance()

parser

public static com.google.protobuf.Parser<SubscriptionList> parser()

getParserForType

public com.google.protobuf.Parser<SubscriptionList> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SubscriptionList getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder