org.opennms.features.openconfig.proto.gnmi

Class Gnmi.SubscribeRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Gnmi.SubscribeRequestOrBuilder

Enclosing class:

Gnmi

public static final class Gnmi.SubscribeRequest
extends com.google.protobuf.GeneratedMessageV3
implements Gnmi.SubscribeRequestOrBuilder

 SubscribeRequest is the message sent by the client to the target when
 initiating a subscription to a set of paths within the data tree. The
 request field must be populated and the initial message must specify a
 SubscriptionList to initiate a subscription. The message is subsequently
 used to define aliases or trigger polled data to be sent by the target.
 Reference: gNMI Specification Section 3.5.1.1
 

Protobuf type gnmi.SubscribeRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gnmi.SubscribeRequest.Builder SubscribeRequest is the message sent by the client to the target when initiating a subscription to a set of paths within the data tree.
static class	Gnmi.SubscribeRequest.RequestCase

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 and Description
static int	ALIASES_FIELD_NUMBER
static int	EXTENSION_FIELD_NUMBER
static int	POLL_FIELD_NUMBER
static int	SUBSCRIBE_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 and Description
boolean	equals(Object obj)
Gnmi.AliasList	getAliases() Aliases to be created.
Gnmi.AliasListOrBuilder	getAliasesOrBuilder() Aliases to be created.
static Gnmi.SubscribeRequest	getDefaultInstance()
Gnmi.SubscribeRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
GnmiExt.Extension	getExtension(int index) Extension messages associated with the SubscribeRequest.
int	getExtensionCount() Extension messages associated with the SubscribeRequest.
List<GnmiExt.Extension>	getExtensionList() Extension messages associated with the SubscribeRequest.
GnmiExt.ExtensionOrBuilder	getExtensionOrBuilder(int index) Extension messages associated with the SubscribeRequest.
List<? extends GnmiExt.ExtensionOrBuilder>	getExtensionOrBuilderList() Extension messages associated with the SubscribeRequest.
com.google.protobuf.Parser<Gnmi.SubscribeRequest>	getParserForType()
Gnmi.Poll	getPoll() Trigger a polled update.
Gnmi.PollOrBuilder	getPollOrBuilder() Trigger a polled update.
Gnmi.SubscribeRequest.RequestCase	getRequestCase()
int	getSerializedSize()
Gnmi.SubscriptionList	getSubscribe() Specify the paths within a subscription.
Gnmi.SubscriptionListOrBuilder	getSubscribeOrBuilder() Specify the paths within a subscription.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAliases() Aliases to be created.
int	hashCode()
boolean	hasPoll() Trigger a polled update.
boolean	hasSubscribe() Specify the paths within a subscription.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Gnmi.SubscribeRequest.Builder	newBuilder()
static Gnmi.SubscribeRequest.Builder	newBuilder(Gnmi.SubscribeRequest prototype)
Gnmi.SubscribeRequest.Builder	newBuilderForType()
protected Gnmi.SubscribeRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Gnmi.SubscribeRequest	parseDelimitedFrom(InputStream input)
static Gnmi.SubscribeRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscribeRequest	parseFrom(byte[] data)
static Gnmi.SubscribeRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscribeRequest	parseFrom(ByteBuffer data)
static Gnmi.SubscribeRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscribeRequest	parseFrom(com.google.protobuf.ByteString data)
static Gnmi.SubscribeRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscribeRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Gnmi.SubscribeRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.SubscribeRequest	parseFrom(InputStream input)
static Gnmi.SubscribeRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Gnmi.SubscribeRequest>	parser()
Gnmi.SubscribeRequest.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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SUBSCRIBE_FIELD_NUMBER

public static final int SUBSCRIBE_FIELD_NUMBER

See Also:

Constant Field Values

POLL_FIELD_NUMBER

public static final int POLL_FIELD_NUMBER

See Also:

Constant Field Values

ALIASES_FIELD_NUMBER

public static final int ALIASES_FIELD_NUMBER

See Also:

Constant Field Values

EXTENSION_FIELD_NUMBER

public static final int EXTENSION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected 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

getRequestCase

public Gnmi.SubscribeRequest.RequestCase getRequestCase()

Specified by:

getRequestCase in interface Gnmi.SubscribeRequestOrBuilder

hasSubscribe

public boolean hasSubscribe()

 Specify the paths within a subscription.
 

.gnmi.SubscriptionList subscribe = 1;

Specified by:

hasSubscribe in interface Gnmi.SubscribeRequestOrBuilder

getSubscribe

public Gnmi.SubscriptionList getSubscribe()

 Specify the paths within a subscription.
 

.gnmi.SubscriptionList subscribe = 1;

Specified by:

getSubscribe in interface Gnmi.SubscribeRequestOrBuilder

getSubscribeOrBuilder

public Gnmi.SubscriptionListOrBuilder getSubscribeOrBuilder()

 Specify the paths within a subscription.
 

.gnmi.SubscriptionList subscribe = 1;

Specified by:

getSubscribeOrBuilder in interface Gnmi.SubscribeRequestOrBuilder

hasPoll

public boolean hasPoll()

 Trigger a polled update.
 

.gnmi.Poll poll = 3;

Specified by:

hasPoll in interface Gnmi.SubscribeRequestOrBuilder

getPoll

public Gnmi.Poll getPoll()

 Trigger a polled update.
 

.gnmi.Poll poll = 3;

Specified by:

getPoll in interface Gnmi.SubscribeRequestOrBuilder

getPollOrBuilder

public Gnmi.PollOrBuilder getPollOrBuilder()

 Trigger a polled update.
 

.gnmi.Poll poll = 3;

Specified by:

getPollOrBuilder in interface Gnmi.SubscribeRequestOrBuilder

hasAliases

public boolean hasAliases()

 Aliases to be created.
 

.gnmi.AliasList aliases = 4;

Specified by:

hasAliases in interface Gnmi.SubscribeRequestOrBuilder

getAliases

public Gnmi.AliasList getAliases()

 Aliases to be created.
 

.gnmi.AliasList aliases = 4;

Specified by:

getAliases in interface Gnmi.SubscribeRequestOrBuilder

getAliasesOrBuilder

public Gnmi.AliasListOrBuilder getAliasesOrBuilder()

 Aliases to be created.
 

.gnmi.AliasList aliases = 4;

Specified by:

getAliasesOrBuilder in interface Gnmi.SubscribeRequestOrBuilder

getExtensionList

public List<GnmiExt.Extension> getExtensionList()

 Extension messages associated with the SubscribeRequest. See the
 gNMI extension specification for further definition.
 

repeated .gnmi_ext.Extension extension = 5;

Specified by:

getExtensionList in interface Gnmi.SubscribeRequestOrBuilder

getExtensionOrBuilderList

public List<? extends GnmiExt.ExtensionOrBuilder> getExtensionOrBuilderList()

 Extension messages associated with the SubscribeRequest. See the
 gNMI extension specification for further definition.
 

repeated .gnmi_ext.Extension extension = 5;

Specified by:

getExtensionOrBuilderList in interface Gnmi.SubscribeRequestOrBuilder

getExtensionCount

public int getExtensionCount()

 Extension messages associated with the SubscribeRequest. See the
 gNMI extension specification for further definition.
 

repeated .gnmi_ext.Extension extension = 5;

Specified by:

getExtensionCount in interface Gnmi.SubscribeRequestOrBuilder

getExtension

public GnmiExt.Extension getExtension(int index)

 Extension messages associated with the SubscribeRequest. See the
 gNMI extension specification for further definition.
 

repeated .gnmi_ext.Extension extension = 5;

Specified by:

getExtension in interface Gnmi.SubscribeRequestOrBuilder

getExtensionOrBuilder

public GnmiExt.ExtensionOrBuilder getExtensionOrBuilder(int index)

 Extension messages associated with the SubscribeRequest. See the
 gNMI extension specification for further definition.
 

repeated .gnmi_ext.Extension extension = 5;

Specified by:

getExtensionOrBuilder in interface Gnmi.SubscribeRequestOrBuilder

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 IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

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(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.SubscribeRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.SubscribeRequest 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.SubscribeRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Gnmi.SubscribeRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Gnmi.SubscribeRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Gnmi.SubscribeRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Gnmi.SubscribeRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Gnmi.SubscribeRequest.Builder newBuilder()

newBuilder

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

toBuilder

public Gnmi.SubscribeRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Gnmi.SubscribeRequest getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder