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

Class Gnmi.SubscriptionList.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, Gnmi.SubscriptionListOrBuilder
    Enclosing class:
    Gnmi.SubscriptionList
    public static final class Gnmi.SubscriptionList.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.SubscriptionList.Builder>
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

    • 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.SubscriptionList.Builder>

      • clear

        public Gnmi.SubscriptionList.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.SubscriptionList.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.SubscriptionList.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Gnmi.SubscriptionList.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.SubscriptionList.Builder>

      • setField

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

      • clearField

        public Gnmi.SubscriptionList.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.SubscriptionList.Builder>

      • clearOneof

        public Gnmi.SubscriptionList.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.SubscriptionList.Builder>

      • setRepeatedField

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

      • addRepeatedField

        public Gnmi.SubscriptionList.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.SubscriptionList.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.SubscriptionList.Builder>

      • mergeFrom

        public Gnmi.SubscriptionList.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.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.SubscriptionList.Builder>
        Throws:
        java.io.IOException

      • getPrefixBuilder

        public Gnmi.Path.Builder getPrefixBuilder()
         Prefix used for paths.
        .gnmi.Path prefix = 1;

      • clearSubscription

        public Gnmi.SubscriptionList.Builder clearSubscription()
         Set of subscriptions to create.
        repeated .gnmi.Subscription subscription = 2;

      • removeSubscription

        public Gnmi.SubscriptionList.Builder removeSubscription​(int index)
         Set of subscriptions to create.
        repeated .gnmi.Subscription subscription = 2;

      • getSubscriptionBuilder

        public Gnmi.Subscription.Builder getSubscriptionBuilder​(int index)
         Set of subscriptions to create.
        repeated .gnmi.Subscription subscription = 2;

      • addSubscriptionBuilder

        public Gnmi.Subscription.Builder addSubscriptionBuilder()
         Set of subscriptions to create.
        repeated .gnmi.Subscription subscription = 2;

      • addSubscriptionBuilder

        public Gnmi.Subscription.Builder addSubscriptionBuilder​(int index)
         Set of subscriptions to create.
        repeated .gnmi.Subscription subscription = 2;

      • getSubscriptionBuilderList

        public java.util.List<Gnmi.Subscription.Builder> getSubscriptionBuilderList()
         Set of subscriptions to create.
        repeated .gnmi.Subscription subscription = 2;

      • setUseAliases

        public Gnmi.SubscriptionList.Builder setUseAliases​(boolean value)
         Whether target defined aliases are allowed within the subscription.
        bool use_aliases = 3;

      • clearUseAliases

        public Gnmi.SubscriptionList.Builder clearUseAliases()
         Whether target defined aliases are allowed within the subscription.
        bool use_aliases = 3;

      • getQosBuilder

        public Gnmi.QOSMarking.Builder getQosBuilder()
         DSCP marking to be used.
        .gnmi.QOSMarking qos = 4;

      • 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

      • setAllowAggregation

        public Gnmi.SubscriptionList.Builder setAllowAggregation​(boolean value)
         Whether elements of the schema that are marked as eligible for aggregation
 should be aggregated or not.
        bool allow_aggregation = 6;

      • clearAllowAggregation

        public Gnmi.SubscriptionList.Builder clearAllowAggregation()
         Whether elements of the schema that are marked as eligible for aggregation
 should be aggregated or not.
        bool allow_aggregation = 6;

      • 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

      • setUseModels

        public Gnmi.SubscriptionList.Builder setUseModels​(int index,
                                                  Gnmi.ModelData value)
         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;

      • setUseModels

        public Gnmi.SubscriptionList.Builder setUseModels​(int index,
                                                  Gnmi.ModelData.Builder builderForValue)
         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;

      • addUseModels

        public Gnmi.SubscriptionList.Builder addUseModels​(Gnmi.ModelData value)
         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;

      • addUseModels

        public Gnmi.SubscriptionList.Builder addUseModels​(int index,
                                                  Gnmi.ModelData value)
         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;

      • addUseModels

        public Gnmi.SubscriptionList.Builder addUseModels​(int index,
                                                  Gnmi.ModelData.Builder builderForValue)
         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;

      • addAllUseModels

        public Gnmi.SubscriptionList.Builder addAllUseModels​(java.lang.Iterable<? extends Gnmi.ModelData> values)
         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;

      • clearUseModels

        public Gnmi.SubscriptionList.Builder clearUseModels()
         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;

      • removeUseModels

        public Gnmi.SubscriptionList.Builder removeUseModels​(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;

      • getUseModelsBuilder

        public Gnmi.ModelData.Builder getUseModelsBuilder​(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;

      • addUseModelsBuilder

        public Gnmi.ModelData.Builder addUseModelsBuilder()
         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;

      • addUseModelsBuilder

        public Gnmi.ModelData.Builder addUseModelsBuilder​(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;

      • getUseModelsBuilderList

        public java.util.List<Gnmi.ModelData.Builder> getUseModelsBuilderList()
         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;

      • 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

      • setEncodingValue

        public Gnmi.SubscriptionList.Builder setEncodingValue​(int value)
         The encoding that the target should use within the Notifications generated
 corresponding to the SubscriptionList.
        .gnmi.Encoding encoding = 8;

      • setEncoding

        public Gnmi.SubscriptionList.Builder setEncoding​(Gnmi.Encoding value)
         The encoding that the target should use within the Notifications generated
 corresponding to the SubscriptionList.
        .gnmi.Encoding encoding = 8;

      • clearEncoding

        public Gnmi.SubscriptionList.Builder clearEncoding()
         The encoding that the target should use within the Notifications generated
 corresponding to the SubscriptionList.
        .gnmi.Encoding encoding = 8;

      • 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

      • setUpdatesOnly

        public Gnmi.SubscriptionList.Builder setUpdatesOnly​(boolean value)
         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;

      • clearUpdatesOnly

        public Gnmi.SubscriptionList.Builder clearUpdatesOnly()
         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;

      • setUnknownFields

        public final Gnmi.SubscriptionList.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.SubscriptionList.Builder>

      • mergeUnknownFields

        public final Gnmi.SubscriptionList.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.SubscriptionList.Builder>