Package org.opennms.features.openconfig.proto.gnmi

Class Gnmi.Notification

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

Gnmi

public static final class Gnmi.Notification
extends com.google.protobuf.GeneratedMessageV3
implements Gnmi.NotificationOrBuilder

 Notification is a re-usable message that is used to encode data from the
 target to the client. A Notification carries two types of changes to the data
 tree:
  - Deleted values (delete) - a set of paths that have been removed from the
    data tree.
  - Updated values (update) - a set of path-value pairs indicating the path
    whose value has changed in the data tree.
 Reference: gNMI Specification Section 2.1
 

Protobuf type gnmi.Notification

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gnmi.Notification.Builder	Notification is a re-usable message that is used to encode data from the target to the client.

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	Description
static int	ALIAS_FIELD_NUMBER
static int	ATOMIC_FIELD_NUMBER
static int	DELETE_FIELD_NUMBER
static int	PREFIX_FIELD_NUMBER
static int	TIMESTAMP_FIELD_NUMBER
static int	UPDATE_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	Description
boolean	equals(Object obj)
String	getAlias()	An alias for the path specified in the prefix field.
com.google.protobuf.ByteString	getAliasBytes()	An alias for the path specified in the prefix field.
boolean	getAtomic()	This notification contains a set of paths that are always updated together referenced by a globally unique prefix.
static Gnmi.Notification	getDefaultInstance()
Gnmi.Notification	getDefaultInstanceForType()
Gnmi.Path	getDelete(int index)	Data elements that have been deleted.
int	getDeleteCount()	Data elements that have been deleted.
List<Gnmi.Path>	getDeleteList()	Data elements that have been deleted.
Gnmi.PathOrBuilder	getDeleteOrBuilder(int index)	Data elements that have been deleted.
List<? extends Gnmi.PathOrBuilder>	getDeleteOrBuilderList()	Data elements that have been deleted.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Gnmi.Notification>	getParserForType()
Gnmi.Path	getPrefix()	Prefix used for paths in the message.
Gnmi.PathOrBuilder	getPrefixOrBuilder()	Prefix used for paths in the message.
int	getSerializedSize()
long	getTimestamp()	Timestamp in nanoseconds since Epoch.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Gnmi.Update	getUpdate(int index)	Data elements that have changed values.
int	getUpdateCount()	Data elements that have changed values.
List<Gnmi.Update>	getUpdateList()	Data elements that have changed values.
Gnmi.UpdateOrBuilder	getUpdateOrBuilder(int index)	Data elements that have changed values.
List<? extends Gnmi.UpdateOrBuilder>	getUpdateOrBuilderList()	Data elements that have changed values.
int	hashCode()
boolean	hasPrefix()	Prefix used for paths in the message.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Gnmi.Notification.Builder	newBuilder()
static Gnmi.Notification.Builder	newBuilder(Gnmi.Notification prototype)
Gnmi.Notification.Builder	newBuilderForType()
protected Gnmi.Notification.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Gnmi.Notification	parseDelimitedFrom(InputStream input)
static Gnmi.Notification	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Notification	parseFrom(byte[] data)
static Gnmi.Notification	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Notification	parseFrom(com.google.protobuf.ByteString data)
static Gnmi.Notification	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Notification	parseFrom(com.google.protobuf.CodedInputStream input)
static Gnmi.Notification	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Notification	parseFrom(InputStream input)
static Gnmi.Notification	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Notification	parseFrom(ByteBuffer data)
static Gnmi.Notification	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Gnmi.Notification>	parser()
Gnmi.Notification.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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

PREFIX_FIELD_NUMBER

public static final int PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

ALIAS_FIELD_NUMBER

public static final int ALIAS_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_FIELD_NUMBER

public static final int UPDATE_FIELD_NUMBER

See Also:

Constant Field Values

DELETE_FIELD_NUMBER

public static final int DELETE_FIELD_NUMBER

See Also:

Constant Field Values

ATOMIC_FIELD_NUMBER

public static final int ATOMIC_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

getTimestamp

public long getTimestamp()

 Timestamp in nanoseconds since Epoch.
 

int64 timestamp = 1;

Specified by:

getTimestamp in interface Gnmi.NotificationOrBuilder

hasPrefix

public boolean hasPrefix()

 Prefix used for paths in the message.
 

.gnmi.Path prefix = 2;

Specified by:

hasPrefix in interface Gnmi.NotificationOrBuilder

getPrefix

public Gnmi.Path getPrefix()

 Prefix used for paths in the message.
 

.gnmi.Path prefix = 2;

Specified by:

getPrefix in interface Gnmi.NotificationOrBuilder

getPrefixOrBuilder

public Gnmi.PathOrBuilder getPrefixOrBuilder()

 Prefix used for paths in the message.
 

.gnmi.Path prefix = 2;

Specified by:

getPrefixOrBuilder in interface Gnmi.NotificationOrBuilder

getAlias

public String getAlias()

 An alias for the path specified in the prefix field.
 Reference: gNMI Specification Section 2.4.2
 

string alias = 3;

Specified by:

getAlias in interface Gnmi.NotificationOrBuilder

getAliasBytes

public com.google.protobuf.ByteString getAliasBytes()

 An alias for the path specified in the prefix field.
 Reference: gNMI Specification Section 2.4.2
 

string alias = 3;

Specified by:

getAliasBytes in interface Gnmi.NotificationOrBuilder

getUpdateList

public List<Gnmi.Update> getUpdateList()

 Data elements that have changed values.
 

repeated .gnmi.Update update = 4;

Specified by:

getUpdateList in interface Gnmi.NotificationOrBuilder

getUpdateOrBuilderList

public List<? extends Gnmi.UpdateOrBuilder> getUpdateOrBuilderList()

 Data elements that have changed values.
 

repeated .gnmi.Update update = 4;

Specified by:

getUpdateOrBuilderList in interface Gnmi.NotificationOrBuilder

getUpdateCount

public int getUpdateCount()

 Data elements that have changed values.
 

repeated .gnmi.Update update = 4;

Specified by:

getUpdateCount in interface Gnmi.NotificationOrBuilder

getUpdate

public Gnmi.Update getUpdate(int index)

 Data elements that have changed values.
 

repeated .gnmi.Update update = 4;

Specified by:

getUpdate in interface Gnmi.NotificationOrBuilder

getUpdateOrBuilder

public Gnmi.UpdateOrBuilder getUpdateOrBuilder(int index)

 Data elements that have changed values.
 

repeated .gnmi.Update update = 4;

Specified by:

getUpdateOrBuilder in interface Gnmi.NotificationOrBuilder

getDeleteList

public List<Gnmi.Path> getDeleteList()

 Data elements that have been deleted.
 

repeated .gnmi.Path delete = 5;

Specified by:

getDeleteList in interface Gnmi.NotificationOrBuilder

getDeleteOrBuilderList

public List<? extends Gnmi.PathOrBuilder> getDeleteOrBuilderList()

 Data elements that have been deleted.
 

repeated .gnmi.Path delete = 5;

Specified by:

getDeleteOrBuilderList in interface Gnmi.NotificationOrBuilder

getDeleteCount

public int getDeleteCount()

 Data elements that have been deleted.
 

repeated .gnmi.Path delete = 5;

Specified by:

getDeleteCount in interface Gnmi.NotificationOrBuilder

getDelete

public Gnmi.Path getDelete(int index)

 Data elements that have been deleted.
 

repeated .gnmi.Path delete = 5;

Specified by:

getDelete in interface Gnmi.NotificationOrBuilder

getDeleteOrBuilder

public Gnmi.PathOrBuilder getDeleteOrBuilder(int index)

 Data elements that have been deleted.
 

repeated .gnmi.Path delete = 5;

Specified by:

getDeleteOrBuilder in interface Gnmi.NotificationOrBuilder

getAtomic

public boolean getAtomic()

 This notification contains a set of paths that are always updated together
 referenced by a globally unique prefix.
 

bool atomic = 6;

Specified by:

getAtomic in interface Gnmi.NotificationOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Gnmi.Notification.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Gnmi.Notification.Builder newBuilder()

newBuilder

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

toBuilder

public Gnmi.Notification.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Gnmi.Notification getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder