Capabilities allows the client to retrieve the set of capabilities that
is supported by the target. This allows the target to validate the
service version that is implemented and retrieve the set of models that
the target supports. The models can then be specified in subsequent RPCs
to restrict the set of data that is utilized.
Reference: gNMI Specification Section 3.2

Retrieve a snapshot of data from the target. A Get RPC requests that the
target snapshots a subset of the data tree as specified by the paths
included in the message and serializes this to be returned to the
client using the specified encoding.
Reference: gNMI Specification Section 3.3

Set allows the client to modify the state of data on the target. The
paths to modified along with the new values that the client wishes
to set the value to.
Reference: gNMI Specification Section 3.4

Subscribe allows a client to request the target to send it values
of particular paths within the data tree. These values may be streamed
at a particular cadence (STREAM), sent one off on a long-lived channel
(POLL), or sent as a one-off retrieval (ONCE).
Reference: gNMI Specification Section 3.5

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

Supported schema models.

Supported encodings.

Supported gNMI version.

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

Set of digits.

Number of digits following the decimal point.

Canonical gRPC error code.

Human readable error.

Optional additional information.

Prefix used for paths.

Paths requested by the client.

The type of data being requested.

Encoding to be used.

The schema models to be used.

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

Data values.

Errors that occurred in the Get.

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

Name of the model.

Organization publishing the model.

Semantic version of the model.

Timestamp in nanoseconds since Epoch.

Prefix used for paths in the message.

Data elements that have changed values.

Data elements that have been deleted.

This notification contains a set of paths that are always updated together
referenced by a globally unique prefix.

Elements of the path are no longer encoded as a string, but rather within
the elem field as a PathElem message.

Label to disambiguate path.

Elements of the path.

The name of the target

The name of the element in the path.

Map of key (attribute) name to value.

The set of elements within the array. Each TypedValue message should
specify only elements that have a field identifier of 1-7 (i.e., the
values are scalar values).

Prefix used for paths in the message.

Paths to be deleted from the data tree.

Updates specifying elements to be replaced.

Updates specifying elements to updated.

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

Prefix used for paths.

A set of responses specifying the result of the operations specified in
the SetRequest.

The overall status of the transaction.

Timestamp of transaction (ns since epoch).

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

Specify the paths within a subscription.

Trigger a polled update.

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

Changed or sampled value for a path.

Indicate target has sent all values associated with the subscription
at least once.

Deprecated in favour of google.golang.org/genproto/googleapis/rpc/status

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

The data tree path.

Subscription mode to be used.

ns between samples in SAMPLE mode.

Indicates whether values that have not changed should be sent in a SAMPLE
subscription.

Specifies the maximum allowable silent period in nanoseconds when
suppress_redundant is in use. The target should send a value at least once
in the period specified.

Prefix used for paths.

Set of subscriptions to create.

DSCP marking to be used.

Whether elements of the schema that are marked as eligible for aggregation
should be aggregated or not.

The set of schemas that define the elements of the data tree that should
be sent by the target.

The encoding that the target should use within the Notifications generated
corresponding to the SubscriptionList.

An optional field to specify that only updates to current state should be
sent to a client. If set, the initial state is not sent to the client but
rather only the sync message followed by any subsequent updates to the
current state. For ONCE and POLL modes, this causes the server to send only
the sync message (Sec. 3.5.2.3).

String value.

Integer value.

Unsigned integer value.

Bool value.

Arbitrary byte sequence value.

Deprecated - use double_val.

Floating point value.

Deprecated - use double_val.

Mixed type scalar array value.

protobuf.Any encoded bytes.

JSON-encoded text.

JSON-encoded text per RFC7951.

Arbitrary ASCII text.

Protobuf binary encoded bytes. The message type is not included.
See the specification at
github.com/openconfig/reference/blob/master/rpc/gnmi/protobuf-vals.md
for a complete specification. [Experimental]

The path (key) for the update.

The value (value) for the update.

The explicitly typed update value.

Number of coalesced duplicates.

Deprecated timestamp for the UpdateResult, this field has been
replaced by the timestamp within the SetResponse message, since
all mutations effected by a set should be applied as a single
transaction.

Path associated with the update.

Status of the update operation.

Update operation type.

Value of the variable being transmitted.

Encoding used for the value field.

JSON encoded text.

Arbitrarily encoded bytes.

Encoded according to scalar values of TypedValue.

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

JSON encoded text as per RFC7951.

All data elements.

Config (rw) only elements.

State (ro) only elements.

Data elements marked in the schema as operational. This refers to data
elements whose value relates to the state of processes or interactions
running on the device.

Values streamed by the target (Sec. 3.5.1.5.2).

Values sent once-off by the target (Sec. 3.5.1.5.1).

Values sent in response to a poll request (Sec. 3.5.1.5.3).

The target selects the relevant mode for each element.

The target sends an update on element value change.

The target samples values according to the interval.

The result relates to a delete of Path.

The result relates to a replace of Path.

The result relates to an update of Path.

The gNMI service semantic version.

A registered extension.

Well known extensions.

Master arbitration extension.

History extension.

Nanoseconds since the epoch

The unique ID assigned to this extension.

The binary-marshalled protobuf extension payload.

More fields can be added if needed, for example, to specify what paths the
role can read/write.

Nanoseconds since the epoch

Nanoseconds since the epoch

New extensions are to be defined within this enumeration - their definition
MUST link to a reference describing their implementation.

An experimental extension that may be used during prototyping of a new
extension.

A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
`path/google.protobuf.Duration`). The name should be in a canonical form
(e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme `http`, `https`, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:

* If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
* Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)

Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com.

Schemes other than `http`, `https` (or the empty scheme) might be
used with implementation specific semantics.

Must be a valid serialized protocol buffer of the above specified type.

Reserved field names, which may not be used by fields in the same message.
A given name may only be reserved once.

Inclusive.

Exclusive.

Inclusive.

Exclusive.

Range of reserved numeric values. Reserved numeric values may not be used
by enum values in the same enum declaration. Reserved ranges may not
overlap.

Reserved enum value names, which may not be reused. A given name may only
be reserved once.

Inclusive.

Inclusive.

Set this option to true to allow mapping different tag names to the same
value.

Is this enum deprecated?
Depending on the target platform, this can emit Deprecated annotations
for the enum, or it will be completely ignored; in the very least, this
is a formalization for deprecating enums. Default: false

Enable the legacy handling of JSON field name conflicts. This lowercases
and strips underscored from the fields before comparison in proto3 only.
The new behavior takes `json_name` into account and applies to proto2 as
well.
TODO(b/261750190) Remove this legacy behavior once downstream teams have
had time to migrate.

The parser stores options it doesn't recognize here. See above.

Is this enum value deprecated?
Depending on the target platform, this can emit Deprecated annotations
for the enum value, or it will be completely ignored; in the very least,
this is a formalization for deprecating enum values. Default: false

The parser stores options it doesn't recognize here. See above.

The parser stores options it doesn't recognize here. See above.

If type_name is set, this need not be set. If both this and type_name
are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

For message and enum types, this is the name of the type. If the name
starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
rules are used to find the type (i.e. first the nested types within this
message are searched, then within the parent, on up to the root
namespace).

For extensions, this is the name of the type being extended. It is
resolved in the same manner as type_name.

For numeric types, contains the original text representation of the value.
For booleans, "true" or "false".
For strings, contains the default text contents (not escaped in any way).
For bytes, contains the C escaped value. All bytes >= 128 are escaped.

If set, gives the index of a oneof in the containing type's oneof_decl
list. This field is a member of that oneof.

JSON name of this field. The value is set by protocol compiler. If the
user has set a "json_name" option on this field, that option's value
will be used. Otherwise, it's deduced from the field's name by converting
it to camelCase.

If true, this is a proto3 "optional". When a proto3 field is optional, it
tracks presence regardless of field type.

When proto3_optional is true, this field must be belong to a oneof to
signal to old proto3 clients that presence is tracked for this field. This
oneof is known as a "synthetic" oneof, and this field must be its sole
member (each proto3 optional field gets its own synthetic oneof). Synthetic
oneofs exist in the descriptor only, and do not generate any API. Synthetic
oneofs must be ordered after all "real" oneofs.

For message fields, proto3_optional doesn't create any semantic change,
since non-repeated message fields always track presence. However it still
indicates the semantic detail of whether the user wrote "optional" or not.
This can be useful for round-tripping the .proto file. For consistency we
give message fields a synthetic oneof also, even though it is not required
to track presence. This is especially important because the parser can't
tell if a field is a message or an enum, so it must always create a
synthetic oneof.

Proto2 optional fields do not set this flag, because they already indicate
optional with `LABEL_OPTIONAL`.

The ctype option instructs the C++ code generator to use a different
representation of the field than it normally would. See the specific
options below. This option is not yet implemented in the open source
release -- sorry, we'll try to include it in a future version! Default: STRING

The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire. Rather than repeatedly
writing the tag and type for each element, the entire array is encoded as
a single length-delimited blob. In proto3, only explicit setting it to
false will avoid using packed encoding.

The jstype option determines the JavaScript type used for values of the
field. The option is permitted only for 64 bit integral and fixed types
(int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
is represented as JavaScript string, which avoids loss of precision that
can happen when a large value is converted to a floating point JavaScript.
Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
use the JavaScript "number" type. The behavior of the default option
JS_NORMAL is implementation dependent.

This option is an enum to permit additional types to be added, e.g.
goog.math.Integer. Default: JS_NORMAL

Should this field be parsed lazily? Lazy applies only to message-type
fields. It means that when the outer message is initially parsed, the
inner message's contents will not be parsed but instead stored in encoded
form. The inner message will actually be parsed when it is first accessed.

This is only a hint. Implementations are free to choose whether to use
eager or lazy parsing regardless of the value of this option. However,
setting this option true suggests that the protocol author believes that
using lazy parsing on this field is worth the additional bookkeeping
overhead typically needed to implement it.

This option does not affect the public interface of any generated code;
all method signatures remain the same. Furthermore, thread-safety of the
interface is not affected by this option; const methods remain safe to
call from multiple threads concurrently, while non-const methods continue
to require exclusive access.

Note that implementations may choose not to check required fields within
a lazy sub-message. That is, calling IsInitialized() on the outer message
may return true even if the inner message has missing required fields.
This is necessary because otherwise the inner message would have to be
parsed in order to perform the check, defeating the purpose of lazy
parsing. An implementation which chooses not to check required fields
must be consistent about it. That is, for any particular sub-message, the
implementation must either *always* check its required fields, or *never*
check its required fields, regardless of whether or not the message has
been parsed.

As of May 2022, lazy verifies the contents of the byte stream during
parsing. An invalid byte stream will cause the overall parsing to fail. Default: false

unverified_lazy does no correctness checks on the byte stream. This should
only be used where lazy with verification is prohibitive for performance
reasons. Default: false

Is this field deprecated?
Depending on the target platform, this can emit Deprecated annotations
for accessors, or it will be completely ignored; in the very least, this
is a formalization for deprecating fields. Default: false

For Google-internal migration only. Do not use. Default: false

Indicate that the field value should not be printed out when using debug
formats, e.g. when the field contains sensitive credentials. Default: false

The parser stores options it doesn't recognize here. See above.

file name, relative to root of source tree

e.g. "foo", "foo.bar", etc.

Names of files imported by this file.

Indexes of the public imported files in the dependency list above.

Indexes of the weak imported files in the dependency list.
For Google-internal migration only. Do not use.

All top-level definitions in this file.

This field contains optional information about the original source code.
You may safely remove this entire field without harming runtime
functionality of the descriptors -- the information is needed only by
development tools.

The syntax of the proto file.
The supported values are "proto2", "proto3", and "editions".

If `edition` is present, this value must be "editions".

The edition of the proto file, which is an opaque string.

Sets the Java package where classes generated from this .proto will be
placed. By default, the proto package is used, but this is often
inappropriate because proto packages do not normally start with backwards
domain names.

Controls the name of the wrapper Java class generated for the .proto file.
That class will always contain the .proto file's getDescriptor() method as
well as any top-level extensions defined in the .proto file.
If java_multiple_files is disabled, then all the other classes from the
.proto file will be nested inside the single wrapper outer class.

If enabled, then the Java code generator will generate a separate .java
file for each top-level message, enum, and service defined in the .proto
file. Thus, these types will *not* be nested inside the wrapper class
named by java_outer_classname. However, the wrapper class will still be
generated to contain the file's getDescriptor() method as well as any
top-level extensions defined in the file. Default: false

This option does nothing.

If set true, then the Java2 code generator will generate code that
throws an exception whenever an attempt is made to assign a non-UTF-8
byte sequence to a string field.
Message reflection will do the same.
However, an extension field still accepts non-UTF-8 byte sequences.
This option has no effect on when used with the lite runtime. Default: false

Default: SPEED

Sets the Go package where structs generated from this .proto will be
placed. If omitted, the Go package will be derived from the following:
- The basename of the package import path, if provided.
- Otherwise, the package statement in the .proto file, if present.
- Otherwise, the basename of the .proto file, without extension.

Should generic services be generated in each language? "Generic" services
are not specific to any particular RPC system. They are generated by the
main code generators in each language (without additional plugins).
Generic services were the only kind of service generation supported by
early versions of google.protobuf.

Generic services are now considered deprecated in favor of using plugins
that generate code specific to your particular RPC system. Therefore,
these default to false. Old code which depends on generic services should
explicitly set them to true. Default: false

Default: false

Default: false

Default: false

Is this file deprecated?
Depending on the target platform, this can emit Deprecated annotations
for everything in the file, or it will be completely ignored; in the very
least, this is a formalization for deprecating files. Default: false

Enables the use of arenas for the proto messages in this file. This applies
only to generated classes for C++. Default: true

Sets the objective c class prefix which is prepended to all objective c
generated classes from this .proto. There is no default.

Namespace for generated classes; defaults to the package.

By default Swift generators will take the proto package and CamelCase it
replacing '.' with underscore and use that to prefix the types/symbols
defined. When this options is provided, they will use this value instead
to prefix the types/symbols defined.

Sets the php class prefix which is prepended to all php generated classes
from this .proto. Default is empty.

Use this option to change the namespace of php generated classes. Default
is empty. When this option is empty, the package name will be used for
determining the namespace.

Use this option to change the namespace of php generated metadata classes.
Default is empty. When this option is empty, the proto file name will be
used for determining the namespace.

Use this option to change the package of ruby generated classes. Default
is empty. When this option is not set, the package name will be used for
determining the ruby package.

The parser stores options it doesn't recognize here.
See the documentation for the "Options" section above.

An Annotation connects some span of text in generated code to an element
of its generating .proto file.

Identifies the element in the original source .proto file. This field
is formatted the same as SourceCodeInfo.Location.path.

Identifies the filesystem path to the original source .proto.

Identifies the starting offset in bytes in the generated code
that relates to the identified object.

Identifies the ending offset in bytes in the generated code that
relates to the identified object. The end offset should be one past
the last relevant byte (so the length of the text = end - begin).

Set true to use the old proto1 MessageSet wire format for extensions.
This is provided for backwards-compatibility with the MessageSet wire
format. You should not use this for any other reason: It's less
efficient, has fewer features, and is more complicated.

The message must be defined exactly as follows:
message Foo {
option message_set_wire_format = true;
extensions 4 to max;
}
Note that the message cannot have any defined fields; MessageSets only
have extensions.

All extensions of your type must be singular messages; e.g. they cannot
be int32s, enums, or repeated messages.

Because this is an option, the above two restrictions are not enforced by
the protocol compiler. Default: false

Disables the generation of the standard "descriptor()" accessor, which can
conflict with a field of the same name. This is meant to make migration
from proto1 easier; new code should avoid fields named "descriptor". Default: false

Is this message deprecated?
Depending on the target platform, this can emit Deprecated annotations
for the message, or it will be completely ignored; in the very least,
this is a formalization for deprecating messages. Default: false

NOTE: Do not set the option in .proto files. Always use the maps syntax
instead. The option should only be implicitly set by the proto compiler
parser.

Whether the message is an automatically generated map entry type for the
maps field.

For maps fields:
map map_field = 1;
The parsed descriptor looks like:
message MapFieldEntry {
option map_entry = true;
optional KeyType key = 1;
optional ValueType value = 2;
}
repeated MapFieldEntry map_field = 1;

Implementations may choose not to generate the map_entry=true message, but
use a native map in the target language to hold the keys and values.
The reflection APIs in such implementations still need to work as
if the field is a repeated message field.

Enable the legacy handling of JSON field name conflicts. This lowercases
and strips underscored from the fields before comparison in proto3 only.
The new behavior takes `json_name` into account and applies to proto2 as
well.

This should only be used as a temporary measure against broken builds due
to the change in behavior for JSON field name conflicts.

TODO(b/261750190) This is legacy behavior we plan to remove once downstream
teams have had time to migrate.

The parser stores options it doesn't recognize here. See above.

Input and output type names. These are resolved in the same way as
FieldDescriptorProto.type_name, but must refer to a message type.

Identifies if client streams multiple client messages Default: false

Identifies if server streams multiple server messages Default: false

Is this method deprecated?
Depending on the target platform, this can emit Deprecated annotations
for the method, or it will be completely ignored; in the very least,
this is a formalization for deprecating methods. Default: false

Default: IDEMPOTENCY_UNKNOWN

The parser stores options it doesn't recognize here. See above.

The parser stores options it doesn't recognize here. See above.

Is this service deprecated?
Depending on the target platform, this can emit Deprecated annotations
for the service, or it will be completely ignored; in the very least,
this is a formalization for deprecating services. Default: false

The parser stores options it doesn't recognize here. See above.

A Location identifies a piece of source code in a .proto file which
corresponds to a particular definition. This information is intended
to be useful to IDEs, code indexers, documentation generators, and similar
tools.

For example, say we have a file like:
message Foo {
optional string foo = 1;
}
Let's look at just the field definition:
optional string foo = 1;
^ ^^ ^^ ^ ^^^
a bc de f ghi
We have the following locations:
span path represents
[a,i) [ 4, 0, 2, 0 ] The whole field definition.
[a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
[c,d) [ 4, 0, 2, 0, 5 ] The type (string).
[e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
[g,h) [ 4, 0, 2, 0, 3 ] The number (1).

Notes:
- A location may refer to a repeated field itself (i.e. not to any
particular index within it). This is used whenever a set of elements are
logically enclosed in a single code segment. For example, an entire
extend block (possibly containing multiple extension definitions) will
have an outer location whose path refers to the "extensions" repeated
field without an index.
- Multiple locations may have the same path. This happens when a single
logical declaration is spread out across multiple places. The most
obvious example is the "extend" block again -- there may be multiple
extend blocks in the same scope, each of which will have the same path.
- A location's span is not always a subset of its parent's span. For
example, the "extendee" of an extension declaration appears at the
beginning of the "extend" block and is shared by all extensions within
the block.
- Just because a location's span is a subset of some other location's span
does not mean that it is a descendant. For example, a "group" defines
both a type and a field in a single declaration. Thus, the locations
corresponding to the type and field and their components will overlap.
- Code which tries to interpret locations should probably be designed to
ignore those that it doesn't understand, as more types of locations could
be recorded in the future.

Identifies which part of the FileDescriptorProto was defined at this
location.

Each element is a field number or an index. They form a path from
the root FileDescriptorProto to the place where the definition occurs.
For example, this path:
[ 4, 3, 2, 7, 1 ]
refers to:
file.message_type(3) // 4, 3
.field(7) // 2, 7
.name() // 1
This is because FileDescriptorProto.message_type has field number 4:
repeated DescriptorProto message_type = 4;
and DescriptorProto.field has field number 2:
repeated FieldDescriptorProto field = 2;
and FieldDescriptorProto.name has field number 1:
optional string name = 1;

Thus, the above path gives the location of a field name. If we removed
the last element:
[ 4, 3, 2, 7 ]
this path refers to the whole field declaration (from the beginning
of the label to the terminating semicolon).

Always has exactly three or four elements: start line, start column,
end line (optional, otherwise assumed same as start line), end column.
These are packed into a single field for efficiency. Note that line
and column numbers are zero-based -- typically you will want to add
1 to each before displaying to a user.

If this SourceCodeInfo represents a complete declaration, these are any
comments appearing before and after the declaration which appear to be
attached to the declaration.

A series of line comments appearing on consecutive lines, with no other
tokens appearing on those lines, will be treated as a single comment.

leading_detached_comments will keep paragraphs of comments that appear
before (but not connected to) the current element. Each paragraph,
separated by empty lines, will be one comment element in the repeated
field.

Only the comment content is provided; comment markers (e.g. //) are
stripped out. For block comments, leading whitespace and an asterisk
will be stripped from the beginning of each line other than the first.
Newlines are included in the output.

Examples:

optional int32 foo = 1; // Comment attached to foo.
// Comment attached to bar.
optional int32 bar = 2;

optional string baz = 3;
// Comment attached to baz.
// Another line attached to baz.

// Comment attached to moo.
//
// Another line attached to moo.
optional double moo = 4;

// Detached comment for corge. This is not leading or trailing comments
// to moo or corge because there are blank lines separating it from
// both.

// Detached comment for corge paragraph 2.

optional string corge = 5;
/* Block comment attached
* to corge. Leading asterisks
* will be removed. */
/* Block comment attached to
* grault. */
optional int32 grault = 6;

// ignored detached comments.

The value of the uninterpreted option, in whatever type the tokenizer
identified it as during parsing. Exactly one of these should be set.