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

Class Gnmi.Subscription.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Gnmi.SubscriptionOrBuilder
    Enclosing class:
    Gnmi.Subscription
    public static final class Gnmi.Subscription.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>
implements Gnmi.SubscriptionOrBuilder
     Subscription is a single request within a SubscriptionList. The path
 specified is interpreted (along with the prefix) as the elements of the data
 tree that the client is subscribing to. The mode determines how the target
 should trigger updates to be sent.
 Reference: gNMI Specification Section 3.5.1.3
    Protobuf type gnmi.Subscription

    • Method Detail

      • 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.Builder<Gnmi.Subscription.Builder>

      • clear

        public Gnmi.Subscription.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • getDefaultInstanceForType

        public Gnmi.Subscription getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Gnmi.Subscription build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Gnmi.Subscription buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Gnmi.Subscription.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • setField

        public Gnmi.Subscription.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • clearField

        public Gnmi.Subscription.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • clearOneof

        public Gnmi.Subscription.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • setRepeatedField

        public Gnmi.Subscription.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • addRepeatedField

        public Gnmi.Subscription.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • mergeFrom

        public Gnmi.Subscription.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Gnmi.Subscription.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • mergeFrom

        public Gnmi.Subscription.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Gnmi.Subscription.Builder>
        Throws:
        IOException

      • getPathBuilder

        public Gnmi.Path.Builder getPathBuilder()
         The data tree path.
        .gnmi.Path path = 1;

      • setModeValue

        public Gnmi.Subscription.Builder setModeValue​(int value)
         Subscription mode to be used.
        .gnmi.SubscriptionMode mode = 2;

      • setSampleInterval

        public Gnmi.Subscription.Builder setSampleInterval​(long value)
         ns between samples in SAMPLE mode.
        uint64 sample_interval = 3;

      • clearSampleInterval

        public Gnmi.Subscription.Builder clearSampleInterval()
         ns between samples in SAMPLE mode.
        uint64 sample_interval = 3;

      • getSuppressRedundant

        public boolean getSuppressRedundant()
         Indicates whether values that have not changed should be sent in a SAMPLE
 subscription.
        bool suppress_redundant = 4;
        Specified by:
        getSuppressRedundant in interface Gnmi.SubscriptionOrBuilder

      • setSuppressRedundant

        public Gnmi.Subscription.Builder setSuppressRedundant​(boolean value)
         Indicates whether values that have not changed should be sent in a SAMPLE
 subscription.
        bool suppress_redundant = 4;

      • clearSuppressRedundant

        public Gnmi.Subscription.Builder clearSuppressRedundant()
         Indicates whether values that have not changed should be sent in a SAMPLE
 subscription.
        bool suppress_redundant = 4;

      • getHeartbeatInterval

        public long getHeartbeatInterval()
         Specifies the maximum allowable silent period in nanoseconds when
 suppress_redundant is in use. The target should send a value at least once
 in the period specified.
        uint64 heartbeat_interval = 5;
        Specified by:
        getHeartbeatInterval in interface Gnmi.SubscriptionOrBuilder

      • setHeartbeatInterval

        public Gnmi.Subscription.Builder setHeartbeatInterval​(long value)
         Specifies the maximum allowable silent period in nanoseconds when
 suppress_redundant is in use. The target should send a value at least once
 in the period specified.
        uint64 heartbeat_interval = 5;

      • clearHeartbeatInterval

        public Gnmi.Subscription.Builder clearHeartbeatInterval()
         Specifies the maximum allowable silent period in nanoseconds when
 suppress_redundant is in use. The target should send a value at least once
 in the period specified.
        uint64 heartbeat_interval = 5;

      • setUnknownFields

        public final Gnmi.Subscription.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>

      • mergeUnknownFields

        public final Gnmi.Subscription.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>