org.opennms.features.openconfig.proto.gnmi

Class Gnmi.GetRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

Gnmi

public static final class Gnmi.GetRequest
extends com.google.protobuf.GeneratedMessageV3
implements Gnmi.GetRequestOrBuilder

 GetRequest is sent when a client initiates a Get RPC. It is used to specify
 the set of data elements for which the target should return a snapshot of
 data. The use_models field specifies the set of schema modules that are to
 be used by the target - where use_models is not specified then the target
 must use all schema models that it has.
 Reference: gNMI Specification Section 3.3.1
 

Protobuf type gnmi.GetRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gnmi.GetRequest.Builder GetRequest is sent when a client initiates a Get RPC.
static class	Gnmi.GetRequest.DataType Type of elements within the data tree.

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	ENCODING_FIELD_NUMBER
static int	EXTENSION_FIELD_NUMBER
static int	PATH_FIELD_NUMBER
static int	PREFIX_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	USE_MODELS_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)
static Gnmi.GetRequest	getDefaultInstance()
Gnmi.GetRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Gnmi.Encoding	getEncoding() Encoding to be used.
int	getEncodingValue() Encoding to be used.
GnmiExt.Extension	getExtension(int index) Extension messages associated with the GetRequest.
int	getExtensionCount() Extension messages associated with the GetRequest.
List<GnmiExt.Extension>	getExtensionList() Extension messages associated with the GetRequest.
GnmiExt.ExtensionOrBuilder	getExtensionOrBuilder(int index) Extension messages associated with the GetRequest.
List<? extends GnmiExt.ExtensionOrBuilder>	getExtensionOrBuilderList() Extension messages associated with the GetRequest.
com.google.protobuf.Parser<Gnmi.GetRequest>	getParserForType()
Gnmi.Path	getPath(int index) Paths requested by the client.
int	getPathCount() Paths requested by the client.
List<Gnmi.Path>	getPathList() Paths requested by the client.
Gnmi.PathOrBuilder	getPathOrBuilder(int index) Paths requested by the client.
List<? extends Gnmi.PathOrBuilder>	getPathOrBuilderList() Paths requested by the client.
Gnmi.Path	getPrefix() Prefix used for paths.
Gnmi.PathOrBuilder	getPrefixOrBuilder() Prefix used for paths.
int	getSerializedSize()
Gnmi.GetRequest.DataType	getType() The type of data being requested.
int	getTypeValue() The type of data being requested.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Gnmi.ModelData	getUseModels(int index) The schema models to be used.
int	getUseModelsCount() The schema models to be used.
List<Gnmi.ModelData>	getUseModelsList() The schema models to be used.
Gnmi.ModelDataOrBuilder	getUseModelsOrBuilder(int index) The schema models to be used.
List<? extends Gnmi.ModelDataOrBuilder>	getUseModelsOrBuilderList() The schema models to be used.
int	hashCode()
boolean	hasPrefix() Prefix used for paths.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Gnmi.GetRequest.Builder	newBuilder()
static Gnmi.GetRequest.Builder	newBuilder(Gnmi.GetRequest prototype)
Gnmi.GetRequest.Builder	newBuilderForType()
protected Gnmi.GetRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Gnmi.GetRequest	parseDelimitedFrom(InputStream input)
static Gnmi.GetRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.GetRequest	parseFrom(byte[] data)
static Gnmi.GetRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.GetRequest	parseFrom(ByteBuffer data)
static Gnmi.GetRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.GetRequest	parseFrom(com.google.protobuf.ByteString data)
static Gnmi.GetRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.GetRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Gnmi.GetRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Gnmi.GetRequest	parseFrom(InputStream input)
static Gnmi.GetRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Gnmi.GetRequest>	parser()
Gnmi.GetRequest.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

PREFIX_FIELD_NUMBER

public static final int PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER

See Also:

Constant Field Values

USE_MODELS_FIELD_NUMBER

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

hasPrefix

public boolean hasPrefix()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

hasPrefix in interface Gnmi.GetRequestOrBuilder

getPrefix

public Gnmi.Path getPrefix()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

getPrefix in interface Gnmi.GetRequestOrBuilder

getPrefixOrBuilder

public Gnmi.PathOrBuilder getPrefixOrBuilder()

 Prefix used for paths.
 

.gnmi.Path prefix = 1;

Specified by:

getPrefixOrBuilder in interface Gnmi.GetRequestOrBuilder

getPathList

public List<Gnmi.Path> getPathList()

 Paths requested by the client.
 

repeated .gnmi.Path path = 2;

Specified by:

getPathList in interface Gnmi.GetRequestOrBuilder

getPathOrBuilderList

public List<? extends Gnmi.PathOrBuilder> getPathOrBuilderList()

 Paths requested by the client.
 

repeated .gnmi.Path path = 2;

Specified by:

getPathOrBuilderList in interface Gnmi.GetRequestOrBuilder

getPathCount

public int getPathCount()

 Paths requested by the client.
 

repeated .gnmi.Path path = 2;

Specified by:

getPathCount in interface Gnmi.GetRequestOrBuilder

getPath

public Gnmi.Path getPath(int index)

 Paths requested by the client.
 

repeated .gnmi.Path path = 2;

Specified by:

getPath in interface Gnmi.GetRequestOrBuilder

getPathOrBuilder

public Gnmi.PathOrBuilder getPathOrBuilder(int index)

 Paths requested by the client.
 

repeated .gnmi.Path path = 2;

Specified by:

getPathOrBuilder in interface Gnmi.GetRequestOrBuilder

getTypeValue

public int getTypeValue()

 The type of data being requested.
 

.gnmi.GetRequest.DataType type = 3;

Specified by:

getTypeValue in interface Gnmi.GetRequestOrBuilder

getType

public Gnmi.GetRequest.DataType getType()

 The type of data being requested.
 

.gnmi.GetRequest.DataType type = 3;

Specified by:

getType in interface Gnmi.GetRequestOrBuilder

getEncodingValue

public int getEncodingValue()

 Encoding to be used.
 

.gnmi.Encoding encoding = 5;

Specified by:

getEncodingValue in interface Gnmi.GetRequestOrBuilder

getEncoding

public Gnmi.Encoding getEncoding()

 Encoding to be used.
 

.gnmi.Encoding encoding = 5;

Specified by:

getEncoding in interface Gnmi.GetRequestOrBuilder

getUseModelsList

public List<Gnmi.ModelData> getUseModelsList()

 The schema models to be used.
 

repeated .gnmi.ModelData use_models = 6;

Specified by:

getUseModelsList in interface Gnmi.GetRequestOrBuilder

getUseModelsOrBuilderList

public List<? extends Gnmi.ModelDataOrBuilder> getUseModelsOrBuilderList()

 The schema models to be used.
 

repeated .gnmi.ModelData use_models = 6;

Specified by:

getUseModelsOrBuilderList in interface Gnmi.GetRequestOrBuilder

getUseModelsCount

public int getUseModelsCount()

 The schema models to be used.
 

repeated .gnmi.ModelData use_models = 6;

Specified by:

getUseModelsCount in interface Gnmi.GetRequestOrBuilder

getUseModels

public Gnmi.ModelData getUseModels(int index)

 The schema models to be used.
 

repeated .gnmi.ModelData use_models = 6;

Specified by:

getUseModels in interface Gnmi.GetRequestOrBuilder

getUseModelsOrBuilder

public Gnmi.ModelDataOrBuilder getUseModelsOrBuilder(int index)

 The schema models to be used.
 

repeated .gnmi.ModelData use_models = 6;

Specified by:

getUseModelsOrBuilder in interface Gnmi.GetRequestOrBuilder

getExtensionList

public List<GnmiExt.Extension> getExtensionList()

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

repeated .gnmi_ext.Extension extension = 7;

Specified by:

getExtensionList in interface Gnmi.GetRequestOrBuilder

getExtensionOrBuilderList

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

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

repeated .gnmi_ext.Extension extension = 7;

Specified by:

getExtensionOrBuilderList in interface Gnmi.GetRequestOrBuilder

getExtensionCount

public int getExtensionCount()

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

repeated .gnmi_ext.Extension extension = 7;

Specified by:

getExtensionCount in interface Gnmi.GetRequestOrBuilder

getExtension

public GnmiExt.Extension getExtension(int index)

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

repeated .gnmi_ext.Extension extension = 7;

Specified by:

getExtension in interface Gnmi.GetRequestOrBuilder

getExtensionOrBuilder

public GnmiExt.ExtensionOrBuilder getExtensionOrBuilder(int index)

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

repeated .gnmi_ext.Extension extension = 7;

Specified by:

getExtensionOrBuilder in interface Gnmi.GetRequestOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Gnmi.GetRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Gnmi.GetRequest.Builder newBuilder()

newBuilder

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

toBuilder

public Gnmi.GetRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Gnmi.GetRequest getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder