Type Members

1.  final case class DescriptorProto(name: scala.Option[String] = _root_.scala.None, field: Seq[FieldDescriptorProto] = _root_.scala.Seq.empty, extension: Seq[FieldDescriptorProto] = _root_.scala.Seq.empty, nestedType: Seq[DescriptorProto] = _root_.scala.Seq.empty, enumType: Seq[EnumDescriptorProto] = _root_.scala.Seq.empty, extensionRange: Seq[ExtensionRange] = _root_.scala.Seq.empty, oneofDecl: Seq[OneofDescriptorProto] = _root_.scala.Seq.empty, options: scala.Option[MessageOptions] = _root_.scala.None, reservedRange: Seq[ReservedRange] = _root_.scala.Seq.empty, reservedName: Seq[String] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[DescriptorProto] with Product with Serializable

   Describes a message type.

   Describes a message type.

   reservedName

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

   Annotations

   @SerialVersionUID()

2.  sealed abstract class Edition extends GeneratedEnum

   The full set of known editions.

3.  final case class EnumDescriptorProto(name: scala.Option[String] = _root_.scala.None, value: Seq[EnumValueDescriptorProto] = _root_.scala.Seq.empty, options: scala.Option[EnumOptions] = _root_.scala.None, reservedRange: Seq[EnumReservedRange] = _root_.scala.Seq.empty, reservedName: Seq[String] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[EnumDescriptorProto] with Product with Serializable

   Describes an enum type.

   Describes an enum type.

   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.

   reservedName

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

   Annotations

   @SerialVersionUID()

4.  final case class EnumOptions(allowAlias: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, deprecatedLegacyJsonFieldConflicts: scala.Option[Boolean] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[EnumOptions] with ExtendableMessage[EnumOptions] with Product with Serializable
   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.

   Annotations

   @SerialVersionUID()

5.  final case class EnumValueDescriptorProto(name: scala.Option[String] = _root_.scala.None, number: scala.Option[Int] = _root_.scala.None, options: scala.Option[EnumValueOptions] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[EnumValueDescriptorProto] with Product with Serializable

   Describes a value within an enum.

   Describes a value within an enum.

   Annotations

   @SerialVersionUID()

6.  final case class EnumValueOptions(deprecated: scala.Option[Boolean] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, debugRedact: scala.Option[Boolean] = _root_.scala.None, featureSupport: scala.Option[FeatureSupport] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[EnumValueOptions] with ExtendableMessage[EnumValueOptions] with Product with Serializable
   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.

   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.

   featureSupport

   Information about the support window of a feature value.

   uninterpretedOption

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

   Annotations

   @SerialVersionUID()

7.  final case class ExtensionRangeOptions(uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, declaration: Seq[Declaration] = _root_.scala.Seq.empty, features: scala.Option[FeatureSet] = _root_.scala.None, verification: scala.Option[VerificationState] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[ExtensionRangeOptions] with ExtendableMessage[ExtensionRangeOptions] with Product with Serializable
   uninterpretedOption

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

   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.

   verification

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

   Annotations

   @SerialVersionUID()

8.  final case class FeatureSet(fieldPresence: scala.Option[FieldPresence] = _root_.scala.None, enumType: scala.Option[EnumType] = _root_.scala.None, repeatedFieldEncoding: scala.Option[RepeatedFieldEncoding] = _root_.scala.None, utf8Validation: scala.Option[Utf8Validation] = _root_.scala.None, messageEncoding: scala.Option[MessageEncoding] = _root_.scala.None, jsonFormat: scala.Option[JsonFormat] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FeatureSet] with ExtendableMessage[FeatureSet] with Product with Serializable

   TODO Enums in C++ gencode (and potentially other languages) are not well scoped.

   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.

   Annotations

   @SerialVersionUID()

9.  final case class FeatureSetDefaults(defaults: Seq[FeatureSetEditionDefault] = _root_.scala.Seq.empty, minimumEdition: scala.Option[Edition] = _root_.scala.None, maximumEdition: scala.Option[Edition] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FeatureSetDefaults] with Product with Serializable

   A compiled specification for the defaults of a set of features.

   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.

   minimumEdition

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

   maximumEdition

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

   Annotations

   @SerialVersionUID()

10.  final case class FieldDescriptorProto(name: scala.Option[String] = _root_.scala.None, number: scala.Option[Int] = _root_.scala.None, label: scala.Option[Label] = _root_.scala.None, type: scala.Option[FieldDescriptorProto.Type] = _root_.scala.None, typeName: scala.Option[String] = _root_.scala.None, extendee: scala.Option[String] = _root_.scala.None, defaultValue: scala.Option[String] = _root_.scala.None, oneofIndex: scala.Option[Int] = _root_.scala.None, jsonName: scala.Option[String] = _root_.scala.None, options: scala.Option[FieldOptions] = _root_.scala.None, proto3Optional: scala.Option[Boolean] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FieldDescriptorProto] with Product with Serializable

    Describes a field within a message.

    Describes a field within a message.

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

    extendee

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

    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.

    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.

    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.

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

    Annotations

    @SerialVersionUID()

11.  final case class FieldOptions(ctype: scala.Option[CType] = _root_.scala.None, packed: scala.Option[Boolean] = _root_.scala.None, jstype: scala.Option[JSType] = _root_.scala.None, lazy: scala.Option[Boolean] = _root_.scala.None, unverifiedLazy: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, weak: scala.Option[Boolean] = _root_.scala.None, debugRedact: scala.Option[Boolean] = _root_.scala.None, retention: scala.Option[OptionRetention] = _root_.scala.None, targets: Seq[OptionTargetType] = _root_.scala.Seq.empty, editionDefaults: Seq[EditionDefault] = _root_.scala.Seq.empty, features: scala.Option[FeatureSet] = _root_.scala.None, featureSupport: scala.Option[FeatureSupport] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FieldOptions] with ExtendableMessage[FieldOptions] with Product with Serializable
    ctype

    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.

    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.

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

    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.

    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.

    weak

    For Google-internal migration only. Do not use.

    debugRedact

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

    features

    Any features defined in the specific edition.

    uninterpretedOption

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

    Annotations

    @SerialVersionUID()

12.  final case class FileDescriptorProto(name: scala.Option[String] = _root_.scala.None, package: scala.Option[String] = _root_.scala.None, dependency: Seq[String] = _root_.scala.Seq.empty, publicDependency: Seq[Int] = _root_.scala.Seq.empty, weakDependency: Seq[Int] = _root_.scala.Seq.empty, messageType: Seq[DescriptorProto] = _root_.scala.Seq.empty, enumType: Seq[EnumDescriptorProto] = _root_.scala.Seq.empty, service: Seq[ServiceDescriptorProto] = _root_.scala.Seq.empty, extension: Seq[FieldDescriptorProto] = _root_.scala.Seq.empty, options: scala.Option[FileOptions] = _root_.scala.None, sourceCodeInfo: scala.Option[SourceCodeInfo] = _root_.scala.None, syntax: scala.Option[String] = _root_.scala.None, edition: scala.Option[Edition] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FileDescriptorProto] with Product with Serializable

    Describes a complete .proto file.

    Describes a complete .proto file.

    name

    file name, relative to root of source tree

    package

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

    dependency

    Names of files imported by this file.

    publicDependency

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

    weakDependency

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

    messageType

    All top-level definitions in this file.

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

    edition

    The edition of the proto file.

    Annotations

    @SerialVersionUID()

13.  final case class FileDescriptorSet(file: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FileDescriptorSet] with Product with Serializable

    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.

    Annotations

    @SerialVersionUID()

14.  final case class FileOptions(javaPackage: scala.Option[String] = _root_.scala.None, javaOuterClassname: scala.Option[String] = _root_.scala.None, javaMultipleFiles: scala.Option[Boolean] = _root_.scala.None, javaGenerateEqualsAndHash: scala.Option[Boolean] = _root_.scala.None, javaStringCheckUtf8: scala.Option[Boolean] = _root_.scala.None, optimizeFor: scala.Option[OptimizeMode] = _root_.scala.None, goPackage: scala.Option[String] = _root_.scala.None, ccGenericServices: scala.Option[Boolean] = _root_.scala.None, javaGenericServices: scala.Option[Boolean] = _root_.scala.None, pyGenericServices: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, ccEnableArenas: scala.Option[Boolean] = _root_.scala.None, objcClassPrefix: scala.Option[String] = _root_.scala.None, csharpNamespace: scala.Option[String] = _root_.scala.None, swiftPrefix: scala.Option[String] = _root_.scala.None, phpClassPrefix: scala.Option[String] = _root_.scala.None, phpNamespace: scala.Option[String] = _root_.scala.None, phpMetadataNamespace: scala.Option[String] = _root_.scala.None, rubyPackage: scala.Option[String] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FileOptions] with ExtendableMessage[FileOptions] with Product with Serializable
    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.

    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.

    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.

    javaGenerateEqualsAndHash

    This option does nothing.

    javaStringCheckUtf8

    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.

    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.

    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.

    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.

    ccEnableArenas

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

    objcClassPrefix

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

    csharpNamespace

    Namespace for generated classes; defaults to the 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.

    phpClassPrefix

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

    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.

    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.

    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.

    features

    Any features defined in the specific edition.

    uninterpretedOption

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

    Annotations

    @SerialVersionUID()

15.  final case class GeneratedCodeInfo(annotation: Seq[Annotation] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[GeneratedCodeInfo] with Product with Serializable

    Describes the relationship between generated code and its original source file.

    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.

    annotation

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

    Annotations

    @SerialVersionUID()

16.  final case class MessageOptions(messageSetWireFormat: scala.Option[Boolean] = _root_.scala.None, noStandardDescriptorAccessor: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, mapEntry: scala.Option[Boolean] = _root_.scala.None, deprecatedLegacyJsonFieldConflicts: scala.Option[Boolean] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[MessageOptions] with ExtendableMessage[MessageOptions] with Product with Serializable
    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".

    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.

    mapEntry

    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.

    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.

    uninterpretedOption

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

    Annotations

    @SerialVersionUID()

17.  final case class MethodDescriptorProto(name: scala.Option[String] = _root_.scala.None, inputType: scala.Option[String] = _root_.scala.None, outputType: scala.Option[String] = _root_.scala.None, options: scala.Option[MethodOptions] = _root_.scala.None, clientStreaming: scala.Option[Boolean] = _root_.scala.None, serverStreaming: scala.Option[Boolean] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[MethodDescriptorProto] with Product with Serializable

    Describes a method of a service.

    Describes a method of a service.

    inputType

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

    clientStreaming

    Identifies if client streams multiple client messages

    serverStreaming

    Identifies if server streams multiple server messages

    Annotations

    @SerialVersionUID()

18.  final case class MethodOptions(deprecated: scala.Option[Boolean] = _root_.scala.None, idempotencyLevel: scala.Option[IdempotencyLevel] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[MethodOptions] with ExtendableMessage[MethodOptions] with Product with Serializable
    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.

    Annotations

    @SerialVersionUID()

19.  final case class OneofDescriptorProto(name: scala.Option[String] = _root_.scala.None, options: scala.Option[OneofOptions] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[OneofDescriptorProto] with Product with Serializable

    Describes a oneof.

    Describes a oneof.

    Annotations

    @SerialVersionUID()

20.  final case class OneofOptions(features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[OneofOptions] with ExtendableMessage[OneofOptions] with Product with Serializable
    features

    Any features defined in the specific edition.

    uninterpretedOption

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

    Annotations

    @SerialVersionUID()

21.  final case class ServiceDescriptorProto(name: scala.Option[String] = _root_.scala.None, method: Seq[MethodDescriptorProto] = _root_.scala.Seq.empty, options: scala.Option[ServiceOptions] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[ServiceDescriptorProto] with Product with Serializable

    Describes a service.

    Describes a service.

    Annotations

    @SerialVersionUID()

22.  final case class ServiceOptions(features: scala.Option[FeatureSet] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[ServiceOptions] with ExtendableMessage[ServiceOptions] with Product with Serializable
    features

    Any features defined in the specific edition.

    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.

    uninterpretedOption

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

    Annotations

    @SerialVersionUID()

23.  final case class SourceCodeInfo(location: Seq[Location] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[SourceCodeInfo] with Product with Serializable

    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.

    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.

    Annotations

    @SerialVersionUID()

24.  final case class UninterpretedOption(name: Seq[NamePart] = _root_.scala.Seq.empty, identifierValue: scala.Option[String] = _root_.scala.None, positiveIntValue: scala.Option[Long] = _root_.scala.None, negativeIntValue: scala.Option[Long] = _root_.scala.None, doubleValue: scala.Option[Double] = _root_.scala.None, stringValue: scala.Option[ByteString] = _root_.scala.None, aggregateValue: scala.Option[String] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[UninterpretedOption] with Product with Serializable

    A message representing a option the parser does not recognize.

    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.

    identifierValue

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

    Annotations

    @SerialVersionUID()