Package org.opennms.features.openconfig.proto.jti

Class Telemetry.Path

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Telemetry.PathOrBuilder
    Enclosing class:
    Telemetry
    public static final class Telemetry.Path
extends com.google.protobuf.GeneratedMessageV3
implements Telemetry.PathOrBuilder
     Data model path
    Protobuf type telemetry.Path
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Telemetry.Path.Builder
      Data model path

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static Telemetry.Path getDefaultInstance()  
      Telemetry.Path getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getFilter()
      Regular expression to be used in filtering state leaves
      com.google.protobuf.ByteString getFilterBytes()
      Regular expression to be used in filtering state leaves
      int getMaxSilentInterval()
      Maximum time in ms the target device may go without sending a message to the collector.
      boolean getNeedEom()
      EOM needed for each walk cycle of this path? For periodic sensor, applicable for each complete reap For event sensor, applicable when initial dump is over (same as EOS) This feature is not implemented currently.
      com.google.protobuf.Parser<Telemetry.Path> getParserForType()  
      java.lang.String getPath()
      Data model path of interest Path specification for elements of OpenConfig data models
      com.google.protobuf.ByteString getPathBytes()
      Data model path of interest Path specification for elements of OpenConfig data models
      int getSampleFrequency()
      Time in ms between collection and transmission of the specified data to the collector platform.
      int getSerializedSize()  
      boolean getSuppressUnchanged()
      If this is set to true, the target device will only send updates to the collector upon a change in data value
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Telemetry.Path.Builder newBuilder()  
      static Telemetry.Path.Builder newBuilder​(Telemetry.Path prototype)  
      Telemetry.Path.Builder newBuilderForType()  
      protected Telemetry.Path.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Telemetry.Path parseDelimitedFrom​(java.io.InputStream input)  
      static Telemetry.Path parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Telemetry.Path parseFrom​(byte[] data)  
      static Telemetry.Path parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Telemetry.Path parseFrom​(com.google.protobuf.ByteString data)  
      static Telemetry.Path parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Telemetry.Path parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Telemetry.Path parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Telemetry.Path parseFrom​(java.io.InputStream input)  
      static Telemetry.Path parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Telemetry.Path parseFrom​(java.nio.ByteBuffer data)  
      static Telemetry.Path parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Telemetry.Path> parser()  
      Telemetry.Path.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

      • SUPPRESS_UNCHANGED_FIELD_NUMBER

        public static final int SUPPRESS_UNCHANGED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_SILENT_INTERVAL_FIELD_NUMBER

        public static final int MAX_SILENT_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SAMPLE_FREQUENCY_FIELD_NUMBER

        public static final int SAMPLE_FREQUENCY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getPath

        public java.lang.String getPath()
         Data model path of interest
 Path specification for elements of OpenConfig data models
        string path = 1;
        Specified by:
        getPath in interface Telemetry.PathOrBuilder

      • getPathBytes

        public com.google.protobuf.ByteString getPathBytes()
         Data model path of interest
 Path specification for elements of OpenConfig data models
        string path = 1;
        Specified by:
        getPathBytes in interface Telemetry.PathOrBuilder

      • getFilter

        public java.lang.String getFilter()
         Regular expression to be used in filtering state leaves
        string filter = 2;
        Specified by:
        getFilter in interface Telemetry.PathOrBuilder

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Regular expression to be used in filtering state leaves
        string filter = 2;
        Specified by:
        getFilterBytes in interface Telemetry.PathOrBuilder

      • getSuppressUnchanged

        public boolean getSuppressUnchanged()
         If this is set to true, the target device will only send
 updates to the collector upon a change in data value
        bool suppress_unchanged = 3;
        Specified by:
        getSuppressUnchanged in interface Telemetry.PathOrBuilder

      • getMaxSilentInterval

        public int getMaxSilentInterval()
         Maximum time in ms the target device may go without sending
 a message to the collector. If this time expires with
 suppress-unchanged set, the target device must send an update
 message regardless if the data values have changed.
        uint32 max_silent_interval = 4;
        Specified by:
        getMaxSilentInterval in interface Telemetry.PathOrBuilder

      • getSampleFrequency

        public int getSampleFrequency()
         Time in ms between collection and transmission of the
 specified data to the collector platform. The target device
 will sample the corresponding data (e.g,. a counter) and
 immediately send to the collector destination.
 If sample-frequency is set to 0, then the network device
 must emit an update upon every datum change.
        uint32 sample_frequency = 5;
        Specified by:
        getSampleFrequency in interface Telemetry.PathOrBuilder

      • getNeedEom

        public boolean getNeedEom()
         EOM needed for each walk cycle of this path?
   For periodic sensor, applicable for each complete reap
   For event sensor, applicable when initial dump is over
     (same as EOS)
 This feature is not implemented currently.
        bool need_eom = 6;
        Specified by:
        getNeedEom in interface Telemetry.PathOrBuilder

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 Telemetry.Path parseFrom​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Telemetry.Path parseFrom​(java.nio.ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Telemetry.Path parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Telemetry.Path parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Telemetry.Path parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Telemetry.Path parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Telemetry.Path parseFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Telemetry.Path parseFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Telemetry.Path parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Telemetry.Path parseDelimitedFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Telemetry.Path parseFrom​(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Telemetry.Path parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Telemetry.Path.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Telemetry.Path.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Telemetry.Path.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Telemetry.Path getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Telemetry.Path> 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 Telemetry.Path getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder