org.opennms.features.openconfig.proto.gnmi

Class Gnmi.SubscriptionList

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.opennms.features.openconfig.proto.gnmi.Gnmi.SubscriptionList

All Implemented Interfaces:

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

Enclosing class:

Gnmi

public static final class Gnmi.SubscriptionList
extends com.google.protobuf.GeneratedMessageV3
implements Gnmi.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	Gnmi.SubscriptionList.Builder SubscriptionList is used within a Subscribe message to specify the list of paths that the client wishes to subscribe to.
static class	Gnmi.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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

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 Gnmi.SubscriptionList	getDefaultInstance()
Gnmi.SubscriptionList	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Gnmi.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.
Gnmi.SubscriptionList.Mode	getMode() .gnmi.SubscriptionList.Mode mode = 5;
int	getModeValue() .gnmi.SubscriptionList.Mode mode = 5;
com.google.protobuf.Parser<Gnmi.SubscriptionList>	getParserForType()
Gnmi.Path	getPrefix() Prefix used for paths.
Gnmi.PathOrBuilder	getPrefixOrBuilder() Prefix used for paths.
Gnmi.QOSMarking	getQos() DSCP marking to be used.
Gnmi.QOSMarkingOrBuilder	getQosOrBuilder() DSCP marking to be used.
int	getSerializedSize()
Gnmi.Subscription	getSubscription(int index) Set of subscriptions to create.
int	getSubscriptionCount() Set of subscriptions to create.
List<Gnmi.Subscription>	getSubscriptionList() Set of subscriptions to create.
Gnmi.SubscriptionOrBuilder	getSubscriptionOrBuilder(int index) Set of subscriptions to create.
List<? extends Gnmi.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.
Gnmi.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<Gnmi.ModelData>	getUseModelsList() The set of schemas that define the elements of the data tree that should be sent by the target.
Gnmi.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 Gnmi.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 Gnmi.SubscriptionList.Builder	newBuilder()
static Gnmi.SubscriptionList.Builder	newBuilder(Gnmi.SubscriptionList prototype)
Gnmi.SubscriptionList.Builder	newBuilderForType()
protected Gnmi.SubscriptionList.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Gnmi.SubscriptionList	parseDelimitedFrom(InputStream input)
static Gnmi.SubscriptionList	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscriptionList	parseFrom(byte[] data)
static Gnmi.SubscriptionList	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscriptionList	parseFrom(ByteBuffer data)
static Gnmi.SubscriptionList	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscriptionList	parseFrom(com.google.protobuf.ByteString data)
static Gnmi.SubscriptionList	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscriptionList	parseFrom(com.google.protobuf.CodedInputStream input)
static Gnmi.SubscriptionList	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscriptionList	parseFrom(InputStream input)
static Gnmi.SubscriptionList	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Gnmi.SubscriptionList>	parser()
Gnmi.SubscriptionList.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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 Gnmi.SubscriptionListOrBuilder

getPrefix

public Gnmi.Path getPrefix()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

getPrefix in interface Gnmi.SubscriptionListOrBuilder

getPrefixOrBuilder

public Gnmi.PathOrBuilder getPrefixOrBuilder()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

getPrefixOrBuilder in interface Gnmi.SubscriptionListOrBuilder

getSubscriptionList

public List<Gnmi.Subscription> getSubscriptionList()

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionList in interface Gnmi.SubscriptionListOrBuilder

getSubscriptionOrBuilderList

public List<? extends Gnmi.SubscriptionOrBuilder> getSubscriptionOrBuilderList()

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionOrBuilderList in interface Gnmi.SubscriptionListOrBuilder

getSubscriptionCount

public int getSubscriptionCount()

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionCount in interface Gnmi.SubscriptionListOrBuilder

getSubscription

public Gnmi.Subscription getSubscription(int index)

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscription in interface Gnmi.SubscriptionListOrBuilder

getSubscriptionOrBuilder

public Gnmi.SubscriptionOrBuilder getSubscriptionOrBuilder(int index)

 Set of subscriptions to create.
 

repeated .gnmi.Subscription subscription = 2;

Specified by:

getSubscriptionOrBuilder in interface Gnmi.SubscriptionListOrBuilder

getUseAliases

public boolean getUseAliases()

 Whether target defined aliases are allowed within the subscription.
 

bool use_aliases = 3;

Specified by:

getUseAliases in interface Gnmi.SubscriptionListOrBuilder

hasQos

public boolean hasQos()

 DSCP marking to be used.
 

.gnmi.QOSMarking qos = 4;

Specified by:

hasQos in interface Gnmi.SubscriptionListOrBuilder

getQos

public Gnmi.QOSMarking getQos()

 DSCP marking to be used.
 

.gnmi.QOSMarking qos = 4;

Specified by:

getQos in interface Gnmi.SubscriptionListOrBuilder

getQosOrBuilder

public Gnmi.QOSMarkingOrBuilder getQosOrBuilder()

 DSCP marking to be used.
 

.gnmi.QOSMarking qos = 4;

Specified by:

getQosOrBuilder in interface Gnmi.SubscriptionListOrBuilder

getModeValue

public int getModeValue()

.gnmi.SubscriptionList.Mode mode = 5;

Specified by:

getModeValue in interface Gnmi.SubscriptionListOrBuilder

getMode

public Gnmi.SubscriptionList.Mode getMode()

.gnmi.SubscriptionList.Mode mode = 5;

Specified by:

getMode in interface Gnmi.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 Gnmi.SubscriptionListOrBuilder

getUseModelsList

public List<Gnmi.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 Gnmi.SubscriptionListOrBuilder

getUseModelsOrBuilderList

public List<? extends Gnmi.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 Gnmi.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 Gnmi.SubscriptionListOrBuilder

getUseModels

public Gnmi.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 Gnmi.SubscriptionListOrBuilder

getUseModelsOrBuilder

public Gnmi.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 Gnmi.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 Gnmi.SubscriptionListOrBuilder

getEncoding

public Gnmi.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 Gnmi.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 Gnmi.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 Gnmi.SubscriptionList parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.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 Gnmi.SubscriptionList parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.SubscriptionList parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Gnmi.SubscriptionList parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Gnmi.SubscriptionList.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Gnmi.SubscriptionList.Builder newBuilder()

newBuilder

public static Gnmi.SubscriptionList.Builder newBuilder(Gnmi.SubscriptionList prototype)

toBuilder

public Gnmi.SubscriptionList.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Gnmi.SubscriptionList getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Gnmi.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 Gnmi.SubscriptionList getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder