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

Interface Telemetry.PathOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Telemetry.Path, Telemetry.Path.Builder
    Enclosing class:
    Telemetry
    public static interface Telemetry.PathOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      boolean getSuppressUnchanged()
      If this is set to true, the target device will only send updates to the collector upon a change in data value

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getPath

        String getPath()
         Data model path of interest
 Path specification for elements of OpenConfig data models
        string path = 1;

      • getPathBytes

        com.google.protobuf.ByteString getPathBytes()
         Data model path of interest
 Path specification for elements of OpenConfig data models
        string path = 1;

      • getFilter

        String getFilter()
         Regular expression to be used in filtering state leaves
        string filter = 2;

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Regular expression to be used in filtering state leaves
        string filter = 2;

      • getSuppressUnchanged

        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;

      • getMaxSilentInterval

        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;

      • getSampleFrequency

        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;

      • getNeedEom

        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;