public final class SubscribeRequest extends com.google.protobuf.GeneratedMessageV3 implements 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.1Protobuf type
gnmi.SubscribeRequest
Modifier and Type | Class and Description |
---|---|
static class |
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 |
SubscribeRequest.RequestCase |
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
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 |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
AliasList |
getAliases()
Aliases to be created.
|
AliasListOrBuilder |
getAliasesOrBuilder()
Aliases to be created.
|
static SubscribeRequest |
getDefaultInstance() |
SubscribeRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Extension |
getExtension(int index)
Extension messages associated with the SubscribeRequest.
|
int |
getExtensionCount()
Extension messages associated with the SubscribeRequest.
|
List<Extension> |
getExtensionList()
Extension messages associated with the SubscribeRequest.
|
ExtensionOrBuilder |
getExtensionOrBuilder(int index)
Extension messages associated with the SubscribeRequest.
|
List<? extends ExtensionOrBuilder> |
getExtensionOrBuilderList()
Extension messages associated with the SubscribeRequest.
|
com.google.protobuf.Parser<SubscribeRequest> |
getParserForType() |
Poll |
getPoll()
Trigger a polled update.
|
PollOrBuilder |
getPollOrBuilder()
Trigger a polled update.
|
SubscribeRequest.RequestCase |
getRequestCase() |
int |
getSerializedSize() |
SubscriptionList |
getSubscribe()
Specify the paths within a subscription.
|
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 SubscribeRequest.Builder |
newBuilder() |
static SubscribeRequest.Builder |
newBuilder(SubscribeRequest prototype) |
SubscribeRequest.Builder |
newBuilderForType() |
protected SubscribeRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static SubscribeRequest |
parseDelimitedFrom(InputStream input) |
static SubscribeRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SubscribeRequest |
parseFrom(byte[] data) |
static SubscribeRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SubscribeRequest |
parseFrom(ByteBuffer data) |
static SubscribeRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SubscribeRequest |
parseFrom(com.google.protobuf.ByteString data) |
static SubscribeRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SubscribeRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static SubscribeRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SubscribeRequest |
parseFrom(InputStream input) |
static SubscribeRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<SubscribeRequest> |
parser() |
SubscribeRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int SUBSCRIBE_FIELD_NUMBER
public static final int POLL_FIELD_NUMBER
public static final int ALIASES_FIELD_NUMBER
public static final int EXTENSION_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public SubscribeRequest.RequestCase getRequestCase()
getRequestCase
in interface SubscribeRequestOrBuilder
public boolean hasSubscribe()
Specify the paths within a subscription.
.gnmi.SubscriptionList subscribe = 1;
hasSubscribe
in interface SubscribeRequestOrBuilder
public SubscriptionList getSubscribe()
Specify the paths within a subscription.
.gnmi.SubscriptionList subscribe = 1;
getSubscribe
in interface SubscribeRequestOrBuilder
public SubscriptionListOrBuilder getSubscribeOrBuilder()
Specify the paths within a subscription.
.gnmi.SubscriptionList subscribe = 1;
getSubscribeOrBuilder
in interface SubscribeRequestOrBuilder
public boolean hasPoll()
Trigger a polled update.
.gnmi.Poll poll = 3;
hasPoll
in interface SubscribeRequestOrBuilder
public Poll getPoll()
Trigger a polled update.
.gnmi.Poll poll = 3;
getPoll
in interface SubscribeRequestOrBuilder
public PollOrBuilder getPollOrBuilder()
Trigger a polled update.
.gnmi.Poll poll = 3;
getPollOrBuilder
in interface SubscribeRequestOrBuilder
public boolean hasAliases()
Aliases to be created.
.gnmi.AliasList aliases = 4;
hasAliases
in interface SubscribeRequestOrBuilder
public AliasList getAliases()
Aliases to be created.
.gnmi.AliasList aliases = 4;
getAliases
in interface SubscribeRequestOrBuilder
public AliasListOrBuilder getAliasesOrBuilder()
Aliases to be created.
.gnmi.AliasList aliases = 4;
getAliasesOrBuilder
in interface SubscribeRequestOrBuilder
public List<Extension> getExtensionList()
Extension messages associated with the SubscribeRequest. See the gNMI extension specification for further definition.
repeated .gnmi_ext.Extension extension = 5;
getExtensionList
in interface SubscribeRequestOrBuilder
public List<? extends ExtensionOrBuilder> getExtensionOrBuilderList()
Extension messages associated with the SubscribeRequest. See the gNMI extension specification for further definition.
repeated .gnmi_ext.Extension extension = 5;
getExtensionOrBuilderList
in interface SubscribeRequestOrBuilder
public int getExtensionCount()
Extension messages associated with the SubscribeRequest. See the gNMI extension specification for further definition.
repeated .gnmi_ext.Extension extension = 5;
getExtensionCount
in interface SubscribeRequestOrBuilder
public Extension getExtension(int index)
Extension messages associated with the SubscribeRequest. See the gNMI extension specification for further definition.
repeated .gnmi_ext.Extension extension = 5;
getExtension
in interface SubscribeRequestOrBuilder
public ExtensionOrBuilder getExtensionOrBuilder(int index)
Extension messages associated with the SubscribeRequest. See the gNMI extension specification for further definition.
repeated .gnmi_ext.Extension extension = 5;
getExtensionOrBuilder
in interface SubscribeRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static SubscribeRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static SubscribeRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static SubscribeRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static SubscribeRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static SubscribeRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static SubscribeRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static SubscribeRequest parseFrom(InputStream input) throws IOException
IOException
public static SubscribeRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static SubscribeRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static SubscribeRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static SubscribeRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static SubscribeRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public SubscribeRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static SubscribeRequest.Builder newBuilder()
public static SubscribeRequest.Builder newBuilder(SubscribeRequest prototype)
public SubscribeRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected SubscribeRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static SubscribeRequest getDefaultInstance()
public static com.google.protobuf.Parser<SubscribeRequest> parser()
public com.google.protobuf.Parser<SubscribeRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public SubscribeRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2018 OpenDaylight. All rights reserved.