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

Class Gnmi.Subscription

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.opennms.features.openconfig.proto.gnmi.Gnmi.Subscription

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Gnmi.SubscriptionOrBuilder

Enclosing class:

Gnmi

public static final class Gnmi.Subscription
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gnmi.Subscription.Builder	Subscription is a single request within a SubscriptionList.

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

Field Summary

Fields

Modifier and Type	Field	Description
static int	HEARTBEAT_INTERVAL_FIELD_NUMBER
static int	MODE_FIELD_NUMBER
static int	PATH_FIELD_NUMBER
static int	SAMPLE_INTERVAL_FIELD_NUMBER
static int	SUPPRESS_REDUNDANT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static Gnmi.Subscription	getDefaultInstance()
Gnmi.Subscription	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Gnmi.Subscription>	getParserForType()
Gnmi.Path	getPath()	The data tree path.
Gnmi.PathOrBuilder	getPathOrBuilder()	The data tree path.
long	getSampleInterval()	ns between samples in SAMPLE mode.
int	getSerializedSize()
boolean	getSuppressRedundant()	Indicates whether values that have not changed should be sent in a SAMPLE subscription.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasPath()	The data tree path.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Gnmi.Subscription.Builder	newBuilder()
static Gnmi.Subscription.Builder	newBuilder(Gnmi.Subscription prototype)
Gnmi.Subscription.Builder	newBuilderForType()
protected Gnmi.Subscription.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Gnmi.Subscription	parseDelimitedFrom(java.io.InputStream input)
static Gnmi.Subscription	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Subscription	parseFrom(byte[] data)
static Gnmi.Subscription	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Subscription	parseFrom(com.google.protobuf.ByteString data)
static Gnmi.Subscription	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Subscription	parseFrom(com.google.protobuf.CodedInputStream input)
static Gnmi.Subscription	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Subscription	parseFrom(java.io.InputStream input)
static Gnmi.Subscription	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.Subscription	parseFrom(java.nio.ByteBuffer data)
static Gnmi.Subscription	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Gnmi.Subscription>	parser()
Gnmi.Subscription.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

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER

See Also:

Constant Field Values

SAMPLE_INTERVAL_FIELD_NUMBER

public static final int SAMPLE_INTERVAL_FIELD_NUMBER

See Also:

Constant Field Values

SUPPRESS_REDUNDANT_FIELD_NUMBER

public static final int SUPPRESS_REDUNDANT_FIELD_NUMBER

See Also:

Constant Field Values

HEARTBEAT_INTERVAL_FIELD_NUMBER

public static final int HEARTBEAT_INTERVAL_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

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

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

getMode

public Gnmi.SubscriptionMode getMode()

 Subscription mode to be used.
 

.gnmi.SubscriptionMode mode = 2;

Specified by:

getMode in interface Gnmi.SubscriptionOrBuilder

getSampleInterval

public long getSampleInterval()

 ns between samples in SAMPLE mode.
 

uint64 sample_interval = 3;

Specified by:

getSampleInterval in interface Gnmi.SubscriptionOrBuilder

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

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

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 Gnmi.Subscription parseFrom(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.Subscription parseFrom(java.nio.ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.Subscription parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.Subscription parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.Subscription parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.Subscription parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.Subscription parseFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Gnmi.Subscription parseFrom(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Gnmi.Subscription parseDelimitedFrom(java.io.InputStream input)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Gnmi.Subscription parseDelimitedFrom(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Gnmi.Subscription parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Gnmi.Subscription parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Gnmi.Subscription.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Gnmi.Subscription.Builder newBuilder()

newBuilder

public static Gnmi.Subscription.Builder newBuilder(Gnmi.Subscription prototype)

toBuilder

public Gnmi.Subscription.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Gnmi.Subscription.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Gnmi.Subscription getDefaultInstance()

parser

public static com.google.protobuf.Parser<Gnmi.Subscription> parser()

getParserForType

public com.google.protobuf.Parser<Gnmi.Subscription> 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 Gnmi.Subscription getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder