root
API
Generated with
root/com.google/com.google.protobuf/com.google.protobuf.descriptor

com.google.protobuf.descriptor

package com.google.protobuf.descriptor

Members list

Type members

Classlikes

final case class DescriptorProto(name: Option[String], field: Seq[FieldDescriptorProto], extension: Seq[FieldDescriptorProto], nestedType: Seq[DescriptorProto], enumType: Seq[EnumDescriptorProto], extensionRange: Seq[ExtensionRange], oneofDecl: Seq[OneofDescriptorProto], options: Option[MessageOptions], reservedRange: Seq[ReservedRange], reservedName: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DescriptorProto]

Describes a message type.

Describes a message type.

Value parameters

reservedName

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

Attributes

Companion
object
Source
DescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DescriptorProto extends GeneratedMessageCompanion[DescriptorProto]

Attributes

Companion
class
Source
DescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object DescriptorProtoCompanion extends GeneratedFileObject

Attributes

Source
DescriptorProtoCompanion.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class Edition(val value: Int) extends GeneratedEnum

The full set of known editions.

The full set of known editions.

Attributes

Companion
object
Source
Edition.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object EDITION_2023
trait Recognized
class Unrecognized
Show all
object Edition extends GeneratedEnumCompanion[Edition]

Attributes

Companion
class
Source
Edition.scala
Supertypes
trait Sum
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Edition.type
final case class EnumDescriptorProto(name: Option[String], value: Seq[EnumValueDescriptorProto], options: Option[EnumOptions], reservedRange: Seq[EnumReservedRange], reservedName: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[EnumDescriptorProto]

Describes an enum type.

Describes an enum type.

Value parameters

reservedName

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

reservedRange

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.

Attributes

Companion
object
Source
EnumDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumDescriptorProto extends GeneratedMessageCompanion[EnumDescriptorProto]

Attributes

Companion
class
Source
EnumDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class EnumOptions(allowAlias: Option[Boolean], deprecated: Option[Boolean], deprecatedLegacyJsonFieldConflicts: Option[Boolean], features: Option[FeatureSet], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[EnumOptions], ExtendableMessage[EnumOptions]

Value parameters

allowAlias

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

deprecated

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.

deprecatedLegacyJsonFieldConflicts

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.

features

Any features defined in the specific edition.

uninterpretedOption

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

Attributes

Companion
object
Source
EnumOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumOptions extends GeneratedMessageCompanion[EnumOptions]

Attributes

Companion
class
Source
EnumOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class EnumValueDescriptorProto(name: Option[String], number: Option[Int], options: Option[EnumValueOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[EnumValueDescriptorProto]

Describes a value within an enum.

Describes a value within an enum.

Attributes

Companion
object
Source
EnumValueDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumValueDescriptorProto extends GeneratedMessageCompanion[EnumValueDescriptorProto]

Attributes

Companion
class
Source
EnumValueDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class EnumValueOptions(deprecated: Option[Boolean], features: Option[FeatureSet], debugRedact: Option[Boolean], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[EnumValueOptions], ExtendableMessage[EnumValueOptions]

Value parameters

debugRedact

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.

deprecated

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.

features

Any features defined in the specific edition.

uninterpretedOption

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

Attributes

Companion
object
Source
EnumValueOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumValueOptions extends GeneratedMessageCompanion[EnumValueOptions]

Attributes

Companion
class
Source
EnumValueOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ExtensionRangeOptions(uninterpretedOption: Seq[UninterpretedOption], declaration: Seq[Declaration], features: Option[FeatureSet], verification: Option[VerificationState], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ExtensionRangeOptions], ExtendableMessage[ExtensionRangeOptions]

Value parameters

declaration

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.

features

Any features defined in the specific edition.

uninterpretedOption

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

verification

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

Attributes

Companion
object
Source
ExtensionRangeOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExtensionRangeOptions extends GeneratedMessageCompanion[ExtensionRangeOptions]

Attributes

Companion
class
Source
ExtensionRangeOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FeatureSet(fieldPresence: Option[FieldPresence], enumType: Option[EnumType], repeatedFieldEncoding: Option[RepeatedFieldEncoding], utf8Validation: Option[Utf8Validation], messageEncoding: Option[MessageEncoding], jsonFormat: Option[JsonFormat], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FeatureSet], ExtendableMessage[FeatureSet]

TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.

TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.

Attributes

Companion
object
Source
FeatureSet.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FeatureSet extends GeneratedMessageCompanion[FeatureSet]

Attributes

Companion
class
Source
FeatureSet.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
FeatureSet.type
final case class FeatureSetDefaults(defaults: Seq[FeatureSetEditionDefault], minimumEdition: Option[Edition], maximumEdition: Option[Edition], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FeatureSetDefaults]

A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.

A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.

Value parameters

maximumEdition

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

minimumEdition

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

Attributes

Companion
object
Source
FeatureSetDefaults.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FeatureSetDefaults extends GeneratedMessageCompanion[FeatureSetDefaults]

Attributes

Companion
class
Source
FeatureSetDefaults.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FieldDescriptorProto(name: Option[String], number: Option[Int], label: Option[Label], `type`: Option[Type], typeName: Option[String], extendee: Option[String], defaultValue: Option[String], oneofIndex: Option[Int], jsonName: Option[String], options: Option[FieldOptions], proto3Optional: Option[Boolean], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FieldDescriptorProto]

Describes a field within a message.

Describes a field within a message.

Value parameters

defaultValue

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.

extendee

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

jsonName

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.

oneofIndex

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

proto3Optional

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.

type

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.

typeName

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

Attributes

Companion
object
Source
FieldDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FieldDescriptorProto extends GeneratedMessageCompanion[FieldDescriptorProto]

Attributes

Companion
class
Source
FieldDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FieldOptions(ctype: Option[CType], packed: Option[Boolean], jstype: Option[JSType], `lazy`: Option[Boolean], unverifiedLazy: Option[Boolean], deprecated: Option[Boolean], weak: Option[Boolean], debugRedact: Option[Boolean], retention: Option[OptionRetention], targets: Seq[OptionTargetType], editionDefaults: Seq[EditionDefault], features: Option[FeatureSet], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FieldOptions], ExtendableMessage[FieldOptions]

Value parameters

ctype

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 -- sorry, we'll try to include other types in a future version!

debugRedact

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

deprecated

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.

features

Any features defined in the specific edition.

jstype

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.

lazy

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.

packed

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.

uninterpretedOption

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

unverifiedLazy

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

weak

For Google-internal migration only. Do not use.

Attributes

Companion
object
Source
FieldOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FieldOptions extends GeneratedMessageCompanion[FieldOptions]

Attributes

Companion
class
Source
FieldOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FileDescriptorProto(name: Option[String], `package`: Option[String], dependency: Seq[String], publicDependency: Seq[Int], weakDependency: Seq[Int], messageType: Seq[DescriptorProto], enumType: Seq[EnumDescriptorProto], service: Seq[ServiceDescriptorProto], extension: Seq[FieldDescriptorProto], options: Option[FileOptions], sourceCodeInfo: Option[SourceCodeInfo], syntax: Option[String], edition: Option[Edition], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FileDescriptorProto]

Describes a complete .proto file.

Describes a complete .proto file.

Value parameters

dependency

Names of files imported by this file.

edition

The edition of the proto file.

messageType

All top-level definitions in this file.

name

file name, relative to root of source tree

package

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

publicDependency

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

sourceCodeInfo

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.

syntax

The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If edition is present, this value must be "editions".

weakDependency

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

Attributes

Companion
object
Source
FileDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileDescriptorProto extends GeneratedMessageCompanion[FileDescriptorProto]

Attributes

Companion
class
Source
FileDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FileDescriptorSet(file: Seq[FileDescriptorProto], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FileDescriptorSet]

The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.

The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.

Attributes

Companion
object
Source
FileDescriptorSet.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileDescriptorSet extends GeneratedMessageCompanion[FileDescriptorSet]

Attributes

Companion
class
Source
FileDescriptorSet.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FileOptions(javaPackage: Option[String], javaOuterClassname: Option[String], javaMultipleFiles: Option[Boolean], javaGenerateEqualsAndHash: Option[Boolean], javaStringCheckUtf8: Option[Boolean], optimizeFor: Option[OptimizeMode], goPackage: Option[String], ccGenericServices: Option[Boolean], javaGenericServices: Option[Boolean], pyGenericServices: Option[Boolean], phpGenericServices: Option[Boolean], deprecated: Option[Boolean], ccEnableArenas: Option[Boolean], objcClassPrefix: Option[String], csharpNamespace: Option[String], swiftPrefix: Option[String], phpClassPrefix: Option[String], phpNamespace: Option[String], phpMetadataNamespace: Option[String], rubyPackage: Option[String], features: Option[FeatureSet], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FileOptions], ExtendableMessage[FileOptions]

Value parameters

ccEnableArenas

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

ccGenericServices

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.

csharpNamespace

Namespace for generated classes; defaults to the package.

deprecated

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.

features

Any features defined in the specific edition.

goPackage

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

This option does nothing.

javaMultipleFiles

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.

javaOuterClassname

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.

javaPackage

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.

javaStringCheckUtf8

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.

objcClassPrefix

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

phpClassPrefix

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

phpMetadataNamespace

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.

phpNamespace

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.

rubyPackage

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.

swiftPrefix

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.

uninterpretedOption

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

Attributes

Companion
object
Source
FileOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileOptions extends GeneratedMessageCompanion[FileOptions]

Attributes

Companion
class
Source
FileOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GeneratedCodeInfo(annotation: Seq[Annotation], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GeneratedCodeInfo]

Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files.

Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files.

Value parameters

annotation

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

Attributes

Companion
object
Source
GeneratedCodeInfo.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GeneratedCodeInfo extends GeneratedMessageCompanion[GeneratedCodeInfo]

Attributes

Companion
class
Source
GeneratedCodeInfo.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class MessageOptions(messageSetWireFormat: Option[Boolean], noStandardDescriptorAccessor: Option[Boolean], deprecated: Option[Boolean], mapEntry: Option[Boolean], deprecatedLegacyJsonFieldConflicts: Option[Boolean], features: Option[FeatureSet], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MessageOptions], ExtendableMessage[MessageOptions]

Value parameters

deprecated

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.

deprecatedLegacyJsonFieldConflicts

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.

features

Any features defined in the specific edition.

mapEntry

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

messageSetWireFormat

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.

noStandardDescriptorAccessor

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

uninterpretedOption

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

Attributes

Companion
object
Source
MessageOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageOptions extends GeneratedMessageCompanion[MessageOptions]

Attributes

Companion
class
Source
MessageOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class MethodDescriptorProto(name: Option[String], inputType: Option[String], outputType: Option[String], options: Option[MethodOptions], clientStreaming: Option[Boolean], serverStreaming: Option[Boolean], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MethodDescriptorProto]

Describes a method of a service.

Describes a method of a service.

Value parameters

clientStreaming

Identifies if client streams multiple client messages

inputType

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

serverStreaming

Identifies if server streams multiple server messages

Attributes

Companion
object
Source
MethodDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MethodDescriptorProto extends GeneratedMessageCompanion[MethodDescriptorProto]

Attributes

Companion
class
Source
MethodDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class MethodOptions(deprecated: Option[Boolean], idempotencyLevel: Option[IdempotencyLevel], features: Option[FeatureSet], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MethodOptions], ExtendableMessage[MethodOptions]

Value parameters

deprecated

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.

features

Any features defined in the specific edition.

uninterpretedOption

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

Attributes

Companion
object
Source
MethodOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MethodOptions extends GeneratedMessageCompanion[MethodOptions]

Attributes

Companion
class
Source
MethodOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class OneofDescriptorProto(name: Option[String], options: Option[OneofOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[OneofDescriptorProto]

Describes a oneof.

Describes a oneof.

Attributes

Companion
object
Source
OneofDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OneofDescriptorProto extends GeneratedMessageCompanion[OneofDescriptorProto]

Attributes

Companion
class
Source
OneofDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class OneofOptions(features: Option[FeatureSet], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[OneofOptions], ExtendableMessage[OneofOptions]

Value parameters

features

Any features defined in the specific edition.

uninterpretedOption

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

Attributes

Companion
object
Source
OneofOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OneofOptions extends GeneratedMessageCompanion[OneofOptions]

Attributes

Companion
class
Source
OneofOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ServiceDescriptorProto(name: Option[String], method: Seq[MethodDescriptorProto], options: Option[ServiceOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ServiceDescriptorProto]

Describes a service.

Describes a service.

Attributes

Companion
object
Source
ServiceDescriptorProto.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServiceDescriptorProto extends GeneratedMessageCompanion[ServiceDescriptorProto]

Attributes

Companion
class
Source
ServiceDescriptorProto.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ServiceOptions(features: Option[FeatureSet], deprecated: Option[Boolean], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ServiceOptions], ExtendableMessage[ServiceOptions]

Value parameters

deprecated

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.

features

Any features defined in the specific edition.

uninterpretedOption

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

Attributes

Companion
object
Source
ServiceOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServiceOptions extends GeneratedMessageCompanion[ServiceOptions]

Attributes

Companion
class
Source
ServiceOptions.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class SourceCodeInfo(location: Seq[Location], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SourceCodeInfo]

Encapsulates information about the original source file from which a FileDescriptorProto was generated.

Encapsulates information about the original source file from which a FileDescriptorProto was generated.

Value parameters

location

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.

Attributes

Companion
object
Source
SourceCodeInfo.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SourceCodeInfo extends GeneratedMessageCompanion[SourceCodeInfo]

Attributes

Companion
class
Source
SourceCodeInfo.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UninterpretedOption(name: Seq[NamePart], identifierValue: Option[String], positiveIntValue: Option[Long], negativeIntValue: Option[Long], doubleValue: Option[Double], stringValue: Option[ByteString], aggregateValue: Option[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UninterpretedOption]

A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.

A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.

Value parameters

identifierValue

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

Attributes

Companion
object
Source
UninterpretedOption.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UninterpretedOption extends GeneratedMessageCompanion[UninterpretedOption]

Attributes

Companion
class
Source
UninterpretedOption.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with