org.opennms.features.openconfig.proto.gnmi

Enum Gnmi.Encoding

java.lang.Object

java.lang.Enum<Gnmi.Encoding>

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

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Gnmi.Encoding>

Enclosing class:

Gnmi

public static enum Gnmi.Encoding
extends Enum<Gnmi.Encoding>
implements com.google.protobuf.ProtocolMessageEnum

 Encoding defines the value encoding formats that are supported by the gNMI
 protocol. These encodings are used by both the client (when sending Set
 messages to modify the state of the target) and the target when serializing
 data to be returned to the client (in both Subscribe and Get RPCs).
 Reference: gNMI Specification Section 2.3
 

Protobuf enum gnmi.Encoding

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCII ASCII text of an out-of-band agreed format.
BYTES Arbitrarily encoded bytes.
JSON JSON encoded text.
JSON_IETF JSON encoded text as per RFC7951.
PROTO Encoded according to out-of-band agreed Protobuf.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCII_VALUE ASCII text of an out-of-band agreed format.
static int	BYTES_VALUE Arbitrarily encoded bytes.
static int	JSON_IETF_VALUE JSON encoded text as per RFC7951.
static int	JSON_VALUE JSON encoded text.
static int	PROTO_VALUE Encoded according to out-of-band agreed Protobuf.

Method Summary

Modifier and Type	Method and Description
static Gnmi.Encoding	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Gnmi.Encoding>	internalGetValueMap()
static Gnmi.Encoding	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Gnmi.Encoding	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Gnmi.Encoding	valueOf(String name) Returns the enum constant of this type with the specified name.
static Gnmi.Encoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JSON

public static final Gnmi.Encoding JSON

 JSON encoded text.
 

JSON = 0;

BYTES

public static final Gnmi.Encoding BYTES

 Arbitrarily encoded bytes.
 

BYTES = 1;

PROTO

public static final Gnmi.Encoding PROTO

 Encoded according to out-of-band agreed Protobuf.
 

PROTO = 2;

ASCII

public static final Gnmi.Encoding ASCII

 ASCII text of an out-of-band agreed format.
 

ASCII = 3;

JSON_IETF

public static final Gnmi.Encoding JSON_IETF

 JSON encoded text as per RFC7951.
 

JSON_IETF = 4;

UNRECOGNIZED

public static final Gnmi.Encoding UNRECOGNIZED

Field Detail

JSON_VALUE

public static final int JSON_VALUE

 JSON encoded text.
 

JSON = 0;

See Also:

Constant Field Values

BYTES_VALUE

public static final int BYTES_VALUE

 Arbitrarily encoded bytes.
 

BYTES = 1;

See Also:

Constant Field Values

PROTO_VALUE

public static final int PROTO_VALUE

 Encoded according to out-of-band agreed Protobuf.
 

PROTO = 2;

See Also:

Constant Field Values

ASCII_VALUE

public static final int ASCII_VALUE

 ASCII text of an out-of-band agreed format.
 

ASCII = 3;

See Also:

Constant Field Values

JSON_IETF_VALUE

public static final int JSON_IETF_VALUE

 JSON encoded text as per RFC7951.
 

JSON_IETF = 4;

See Also:

Constant Field Values

Method Detail

values

public static Gnmi.Encoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Gnmi.Encoding c : Gnmi.Encoding.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Gnmi.Encoding valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static Gnmi.Encoding valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static Gnmi.Encoding forNumber(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Gnmi.Encoding> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Gnmi.Encoding valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)