Gnmi.Subscription.Builder (OpenNMS 2021.1.17 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Gnmi.Subscription.Builder>
    - - org.opennms.features.openconfig.proto.gnmi.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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Gnmi.Subscription.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Gnmi.Subscription`	`build()`
`Gnmi.Subscription`	`buildPartial()`
`Gnmi.Subscription.Builder`	`clear()`
`Gnmi.Subscription.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Gnmi.Subscription.Builder`	`clearHeartbeatInterval()` Specifies the maximum allowable silent period in nanoseconds when suppress_redundant is in use.
`Gnmi.Subscription.Builder`	`clearMode()` Subscription mode to be used.
`Gnmi.Subscription.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Gnmi.Subscription.Builder`	`clearPath()` The data tree path.
`Gnmi.Subscription.Builder`	`clearSampleInterval()` ns between samples in SAMPLE mode.
`Gnmi.Subscription.Builder`	`clearSuppressRedundant()` Indicates whether values that have not changed should be sent in a SAMPLE subscription.
`Gnmi.Subscription.Builder`	`clone()`
`Gnmi.Subscription`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getHeartbeatInterval()` Specifies the maximum allowable silent period in nanoseconds when suppress_redundant is in use.
`Gnmi.SubscriptionMode`	`getMode()` Subscription mode to be used.
`int`	`getModeValue()` Subscription mode to be used.
`Gnmi.Path`	`getPath()` The data tree path.
`Gnmi.Path.Builder`	`getPathBuilder()` The data tree path.
`Gnmi.PathOrBuilder`	`getPathOrBuilder()` The data tree path.
`long`	`getSampleInterval()` ns between samples in SAMPLE mode.
`boolean`	`getSuppressRedundant()` Indicates whether values that have not changed should be sent in a SAMPLE subscription.
`boolean`	`hasPath()` The data tree path.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Gnmi.Subscription.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Gnmi.Subscription.Builder`	`mergeFrom(Gnmi.Subscription other)`
`Gnmi.Subscription.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Gnmi.Subscription.Builder`	`mergePath(Gnmi.Path value)` The data tree path.
`Gnmi.Subscription.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Gnmi.Subscription.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Gnmi.Subscription.Builder`	`setHeartbeatInterval(long value)` Specifies the maximum allowable silent period in nanoseconds when suppress_redundant is in use.
`Gnmi.Subscription.Builder`	`setMode(Gnmi.SubscriptionMode value)` Subscription mode to be used.
`Gnmi.Subscription.Builder`	`setModeValue(int value)` Subscription mode to be used.
`Gnmi.Subscription.Builder`	`setPath(Gnmi.Path.Builder builderForValue)` The data tree path.
`Gnmi.Subscription.Builder`	`setPath(Gnmi.Path value)` The data tree path.
`Gnmi.Subscription.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Gnmi.Subscription.Builder`	`setSampleInterval(long value)` ns between samples in SAMPLE mode.
`Gnmi.Subscription.Builder`	`setSuppressRedundant(boolean value)` Indicates whether values that have not changed should be sent in a SAMPLE subscription.
`Gnmi.Subscription.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- 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>
  - mergeFrom
```
public Gnmi.Subscription.Builder mergeFrom(Gnmi.Subscription other)
```
  - 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
  - hasPath
```
public boolean hasPath()
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
    Specified by:
    
    hasPath in interface Gnmi.SubscriptionOrBuilder
  - getPath
```
public Gnmi.Path getPath()
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
    Specified by:
    
    getPath in interface Gnmi.SubscriptionOrBuilder
  - setPath
```
public Gnmi.Subscription.Builder setPath(Gnmi.Path value)
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
  - setPath
```
public Gnmi.Subscription.Builder setPath(Gnmi.Path.Builder builderForValue)
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
  - mergePath
```
public Gnmi.Subscription.Builder mergePath(Gnmi.Path value)
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
  - clearPath
```
public Gnmi.Subscription.Builder clearPath()
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
  - getPathBuilder
```
public Gnmi.Path.Builder getPathBuilder()
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
  - getPathOrBuilder
```
public Gnmi.PathOrBuilder getPathOrBuilder()
```
```
 The data tree path.
 
```
    .gnmi.Path path = 1;
    Specified by:
    
    getPathOrBuilder in interface Gnmi.SubscriptionOrBuilder
  - getModeValue
```
public int getModeValue()
```
```
 Subscription mode to be used.
 
```
    .gnmi.SubscriptionMode mode = 2;
    Specified by:
    
    getModeValue in interface Gnmi.SubscriptionOrBuilder
  - setModeValue
```
public Gnmi.Subscription.Builder setModeValue(int value)
```
```
 Subscription mode to be used.
 
```
    .gnmi.SubscriptionMode mode = 2;
  - getMode
```
public Gnmi.SubscriptionMode getMode()
```
```
 Subscription mode to be used.
 
```
    .gnmi.SubscriptionMode mode = 2;
    Specified by:
    
    getMode in interface Gnmi.SubscriptionOrBuilder
  - setMode
```
public Gnmi.Subscription.Builder setMode(Gnmi.SubscriptionMode value)
```
```
 Subscription mode to be used.
 
```
    .gnmi.SubscriptionMode mode = 2;
  - clearMode
```
public Gnmi.Subscription.Builder clearMode()
```
```
 Subscription mode to be used.
 
```
    .gnmi.SubscriptionMode mode = 2;
  - getSampleInterval
```
public long getSampleInterval()
```
```
 ns between samples in SAMPLE mode.
 
```
    uint64 sample_interval = 3;
    Specified by:
    
    getSampleInterval in interface Gnmi.SubscriptionOrBuilder
  - 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>

Class Gnmi.Subscription.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasPath

getPath

setPath

setPath

mergePath

clearPath

getPathBuilder

getPathOrBuilder

getModeValue

setModeValue

getMode

setMode

clearMode

getSampleInterval

setSampleInterval

clearSampleInterval

getSuppressRedundant

setSuppressRedundant

clearSuppressRedundant

getHeartbeatInterval

setHeartbeatInterval

clearHeartbeatInterval

setUnknownFields

mergeUnknownFields