Protocol Documentation

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. As of May 2023, there are no widely used type server implementations and no plans to implement one. 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.

might be empty, in that case we don't have the history to calculate the conflicting attributes

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

Deprecated. 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 Remove this legacy behavior once downstream teams have had time to migrate.

Any features defined in the specific edition.

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

Any features defined in the specific edition.

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

Information about the support window of a feature value.

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

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

For external users: DO NOT USE. We are in the process of open sourcing extension declaration and executing internal cleanups before it can be used externally.

Any features defined in the specific edition.

The verification state of the range. TODO: flip the default to DECLARATION once all empty ranges are marked as UNVERIFIED. Default: UNVERIFIED

The extension number declared within the extension range.

The fully-qualified name of the extension field. There must be a leading dot in front of the full name.

The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.

If true, indicates that the number is reserved in the extension range, and any extension field with the number will fail to compile. Set this when a declared extension field is deleted.

If true, indicates that the extension must be defined as repeated. Otherwise the extension must be defined as optional.

The minimum supported edition (inclusive) when this was constructed. Editions before this will not have defaults.

The maximum known edition (inclusive) when this was constructed. Editions after this will not have reliable defaults.

Defaults of features that can be overridden in this edition.

Defaults of features that can't be overridden in this edition.

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 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`.

NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated. 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. This option is prohibited in Editions, but the `repeated_field_encoding` feature can be used to control the behavior.

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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable). 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

Any features defined in the specific edition.

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

Textproto value.

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

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.

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

Deprecated. This option does nothing.

A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field. TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks. 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

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.

Any features defined in the specific edition.

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

Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> 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. 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.

Deprecated. 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 This is legacy behavior we plan to remove once downstream teams have had time to migrate.

Any features defined in the specific edition.

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

Any features defined in the specific edition.

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

Any features defined in the specific edition.

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

Any features defined in the specific edition.

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 appears. 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.

the id of the created organization

the id of the user that created the organization

the id of the deleted organization

The Authorization Request URL including Client ID, Scopes and so on. Start the Auth Flow by redirecting here. State and PKCE should be populated by the client

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

information more precise than date information shall be disregarded by clients @gotags: validate:"required"

What kind of subject does this property belong to @gotags: validate:"required"

What kind of data can be attached using this Property? @gotags: validate:"required"

readable identifier for this property (should, but does not have to be unique) @gotags: validate:"required"

Optional field for more context

ID of set this Property should belong to Not implemented yet

allows admins to allow or prevent users of using select fields like free-text fields, this means unknown options will be added to the option set when entered.

@gotags: validate:"dive"

@gotags: validate:"required"

uuid of the property

id of set this Property should belong to

@gotags: validate:"uuid4"

describes from which View (global, ward, ...) the property is accessed from The attribute "always_include_for_current_context" depends on this ViewSource

@gotags: validate:"omitempty,omitnil,uuid4"

id of set this Property should belong to

This value is dependend on the ViewSource

@gotags: validate:"uuid4"

ID of set this Property should belong to

no conflict detection, if not provided

@gotags: validate:"dive,uuid4"

@gotags: validate:"dive"

@gotags: validate:"omitempty,uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"required" // FIELD_TYPE_TEXT

FIELD_TYPE_NUMBER

FIELD_TYPE_CHECKBOX

FIELD_TYPE_DATE

FIELD_TYPE_DATE_TIME

@gotags: validate:"uuid4" // FIELD_TYPE_SELECT, id of option

FIELD_TYPE_MULTI_SELECT

optional consistency of existing value (not of the property!), no conflict detection, if not provided

@gotags: validate:"dive,uuid4" // ids of options to add

@gotags: validate:"dive,uuid4" // in case a PV is already attached with multiple select values, you can remove them here

FIELD_TYPE_TEXT

FIELD_TYPE_NUMBER

FIELD_TYPE_CHECKBOX

FIELD_TYPE_DATE

FIELD_TYPE_DATE_TIME

FIELD_TYPE_SELECT, id of option

missing, if no value available

@gotags: validate:"omitempty,omitnil,uuid4"

@gotags: validate:"omitempty,omitnil,uuid4"

@gotags: validate:"omitempty,omitnil,uuid4"

@gotags: validate:"omitempty,omitnil,uuid4"

append property_id to the always_include list this means the property is shown, unless a more specific rule (including itself) puts it in its dont_always_include list @gotags: validate:"dive,uuid4"

remove property_id to the always_include list, also see append_to_always_include @gotags: validate:"dive,uuid4"

append property_id to the dont_always_include list, also see append_to_always_include @gotags: validate:"dive,uuid4"

remove property_id to the dont_always_include list, also see append_to_always_include @gotags: validate:"dive,uuid4"

@gotags: validate:"required"

@gotags: validate:"uuid4"

@gotags: validate:"required"

@gotags: validate:"uuid4"

@gotags: validate:"required"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"omitnil,uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"omitempty,omitnil,uuid4"

no conflict detection, if not provided

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

no conflict detection, if not provided

@gotags: validate:"required"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

no conflict detection, if not provided

@gotags: validate:"uuid4"

no conflict detection, if not provided

@gotags: validate:"required"

@gotags: validate:"required"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"

@gotags: validate:"uuid4"