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,java.io.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 typegnmi.SubscribeRequest- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGnmi.SubscribeRequest.BuilderSubscribeRequest is the message sent by the client to the target when initiating a subscription to a set of paths within the data tree.static classGnmi.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
-
-
Field Summary
Fields Modifier and Type Field Description static intALIASES_FIELD_NUMBERstatic intEXTENSION_FIELD_NUMBERstatic intPOLL_FIELD_NUMBERstatic intSUBSCRIBE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)Gnmi.AliasListgetAliases()Aliases to be created.Gnmi.AliasListOrBuildergetAliasesOrBuilder()Aliases to be created.static Gnmi.SubscribeRequestgetDefaultInstance()Gnmi.SubscribeRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()GnmiExt.ExtensiongetExtension(int index)Extension messages associated with the SubscribeRequest.intgetExtensionCount()Extension messages associated with the SubscribeRequest.java.util.List<GnmiExt.Extension>getExtensionList()Extension messages associated with the SubscribeRequest.GnmiExt.ExtensionOrBuildergetExtensionOrBuilder(int index)Extension messages associated with the SubscribeRequest.java.util.List<? extends GnmiExt.ExtensionOrBuilder>getExtensionOrBuilderList()Extension messages associated with the SubscribeRequest.com.google.protobuf.Parser<Gnmi.SubscribeRequest>getParserForType()Gnmi.PollgetPoll()Trigger a polled update.Gnmi.PollOrBuildergetPollOrBuilder()Trigger a polled update.Gnmi.SubscribeRequest.RequestCasegetRequestCase()intgetSerializedSize()Gnmi.SubscriptionListgetSubscribe()Specify the paths within a subscription.Gnmi.SubscriptionListOrBuildergetSubscribeOrBuilder()Specify the paths within a subscription.com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasAliases()Aliases to be created.inthashCode()booleanhasPoll()Trigger a polled update.booleanhasSubscribe()Specify the paths within a subscription.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static Gnmi.SubscribeRequest.BuildernewBuilder()static Gnmi.SubscribeRequest.BuildernewBuilder(Gnmi.SubscribeRequest prototype)Gnmi.SubscribeRequest.BuildernewBuilderForType()protected Gnmi.SubscribeRequest.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected java.lang.ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static Gnmi.SubscribeRequestparseDelimitedFrom(java.io.InputStream input)static Gnmi.SubscribeRequestparseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Gnmi.SubscribeRequestparseFrom(byte[] data)static Gnmi.SubscribeRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Gnmi.SubscribeRequestparseFrom(com.google.protobuf.ByteString data)static Gnmi.SubscribeRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Gnmi.SubscribeRequestparseFrom(com.google.protobuf.CodedInputStream input)static Gnmi.SubscribeRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Gnmi.SubscribeRequestparseFrom(java.io.InputStream input)static Gnmi.SubscribeRequestparseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Gnmi.SubscribeRequestparseFrom(java.nio.ByteBuffer data)static Gnmi.SubscribeRequestparseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Gnmi.SubscribeRequest>parser()Gnmi.SubscribeRequest.BuildertoBuilder()voidwriteTo(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
-
-
-
-
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 java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getRequestCase
public Gnmi.SubscribeRequest.RequestCase getRequestCase()
- Specified by:
getRequestCasein interfaceGnmi.SubscribeRequestOrBuilder
-
hasSubscribe
public boolean hasSubscribe()
Specify the paths within a subscription.
.gnmi.SubscriptionList subscribe = 1;- Specified by:
hasSubscribein interfaceGnmi.SubscribeRequestOrBuilder
-
getSubscribe
public Gnmi.SubscriptionList getSubscribe()
Specify the paths within a subscription.
.gnmi.SubscriptionList subscribe = 1;- Specified by:
getSubscribein interfaceGnmi.SubscribeRequestOrBuilder
-
getSubscribeOrBuilder
public Gnmi.SubscriptionListOrBuilder getSubscribeOrBuilder()
Specify the paths within a subscription.
.gnmi.SubscriptionList subscribe = 1;- Specified by:
getSubscribeOrBuilderin interfaceGnmi.SubscribeRequestOrBuilder
-
hasPoll
public boolean hasPoll()
Trigger a polled update.
.gnmi.Poll poll = 3;- Specified by:
hasPollin interfaceGnmi.SubscribeRequestOrBuilder
-
getPoll
public Gnmi.Poll getPoll()
Trigger a polled update.
.gnmi.Poll poll = 3;- Specified by:
getPollin interfaceGnmi.SubscribeRequestOrBuilder
-
getPollOrBuilder
public Gnmi.PollOrBuilder getPollOrBuilder()
Trigger a polled update.
.gnmi.Poll poll = 3;- Specified by:
getPollOrBuilderin interfaceGnmi.SubscribeRequestOrBuilder
-
hasAliases
public boolean hasAliases()
Aliases to be created.
.gnmi.AliasList aliases = 4;- Specified by:
hasAliasesin interfaceGnmi.SubscribeRequestOrBuilder
-
getAliases
public Gnmi.AliasList getAliases()
Aliases to be created.
.gnmi.AliasList aliases = 4;- Specified by:
getAliasesin interfaceGnmi.SubscribeRequestOrBuilder
-
getAliasesOrBuilder
public Gnmi.AliasListOrBuilder getAliasesOrBuilder()
Aliases to be created.
.gnmi.AliasList aliases = 4;- Specified by:
getAliasesOrBuilderin interfaceGnmi.SubscribeRequestOrBuilder
-
getExtensionList
public java.util.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:
getExtensionListin interfaceGnmi.SubscribeRequestOrBuilder
-
getExtensionOrBuilderList
public java.util.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:
getExtensionOrBuilderListin interfaceGnmi.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:
getExtensionCountin interfaceGnmi.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:
getExtensionin interfaceGnmi.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:
getExtensionOrBuilderin interfaceGnmi.SubscribeRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Gnmi.SubscribeRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Gnmi.SubscribeRequest parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Gnmi.SubscribeRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Gnmi.SubscribeRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Gnmi.SubscribeRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Gnmi.SubscribeRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Gnmi.SubscribeRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Gnmi.SubscribeRequest.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Gnmi.SubscribeRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Gnmi.SubscribeRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-