package options
- Alphabetic
- Public
- Protected
Type Members
- final case class EnumOptions(extends: Seq[String] = _root_.scala.Seq.empty, companionExtends: Seq[String] = _root_.scala.Seq.empty, type: Option[String] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Message[EnumOptions] with Updatable[EnumOptions] with Product with Serializable
- extends
Additional classes and traits to mix in to the base trait
- companionExtends
Additional classes and traits to mix in to the companion object.
- type
All instances of this enum will be converted to this type. An implicit TypeMapper must be present.
- Annotations
- @SerialVersionUID()
- final case class EnumValueOptions(extends: Seq[String] = _root_.scala.Seq.empty, scalaName: Option[String] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Message[EnumValueOptions] with Updatable[EnumValueOptions] with Product with Serializable
- extends
Additional classes and traits to mix in to an individual enum value.
- scalaName
Name in Scala to use for this enum value.
- Annotations
- @SerialVersionUID()
- final case class FieldOptions(type: Option[String] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, keyType: Option[String] = _root_.scala.None, valueType: Option[String] = _root_.scala.None, annotations: Seq[String] = _root_.scala.Seq.empty, mapType: Option[String] = _root_.scala.None, noBox: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Message[FieldOptions] with Updatable[FieldOptions] with Product with Serializable
- collectionType
Can be specified only if this field is repeated. If unspecified, it falls back to the file option named
collection_type
, which defaults toscala.collection.Seq
.- keyType
If the field is a map, you can specify custom Scala types for the key or value.
- annotations
Custom annotations to add to the field.
- mapType
Can be specified only if this field is a map. If unspecified, it falls back to the file option named
map_type
which defaults toscala.collection.immutable.Map
- noBox
Do not box this value in Option[T]. If set, this overrides MessageOptions.no_box
- Annotations
- @SerialVersionUID()
- final case class MessageOptions(extends: Seq[String] = _root_.scala.Seq.empty, companionExtends: Seq[String] = _root_.scala.Seq.empty, annotations: Seq[String] = _root_.scala.Seq.empty, type: Option[String] = _root_.scala.None, companionAnnotations: Seq[String] = _root_.scala.Seq.empty, sealedOneofExtends: Seq[String] = _root_.scala.Seq.empty, noBox: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Message[MessageOptions] with Updatable[MessageOptions] with Product with Serializable
- extends
Additional classes and traits to mix in to the case class.
- companionExtends
Additional classes and traits to mix in to the companion object.
- annotations
Custom annotations to add to the generated case class.
- type
All instances of this message will be converted to this type. An implicit TypeMapper must be present.
- companionAnnotations
Custom annotations to add to the companion object of the generated class.
- sealedOneofExtends
Additional classes and traits to mix in to generated sealed_oneof base trait.
- noBox
If true, when this message is used as an optional field, do not wrap it in an
Option
. This is equivalent of setting(field).no_box
to true on each field with the message type.
- Annotations
- @SerialVersionUID()
- final case class OneofOptions(extends: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Message[OneofOptions] with Updatable[OneofOptions] with Product with Serializable
- extends
Additional traits to mix in to a oneof.
- Annotations
- @SerialVersionUID()
- final case class ScalaPbOptions(packageName: Option[String] = _root_.scala.None, flatPackage: Option[Boolean] = _root_.scala.None, import: Seq[String] = _root_.scala.Seq.empty, preamble: Seq[String] = _root_.scala.Seq.empty, singleFile: Option[Boolean] = _root_.scala.None, noPrimitiveWrappers: Option[Boolean] = _root_.scala.None, primitiveWrappers: Option[Boolean] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, preserveUnknownFields: Option[Boolean] = _root_.scala.None, objectName: Option[String] = _root_.scala.None, scope: Option[OptionsScope] = _root_.scala.None, lenses: Option[Boolean] = _root_.scala.None, retainSourceCodeInfo: Option[Boolean] = _root_.scala.None, mapType: Option[String] = _root_.scala.None, noDefaultValuesInConstructor: Option[Boolean] = _root_.scala.None, enumValueNaming: Option[EnumValueNaming] = _root_.scala.None, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Message[ScalaPbOptions] with Updatable[ScalaPbOptions] with Product with Serializable
- packageName
If set then it overrides the java_package and package.
- flatPackage
If true, the compiler does not append the proto base file name into the generated package name. If false (the default), the generated scala package name is the package_name.basename where basename is the proto file name without the .proto extension.
- import
Adds the following imports at the top of the file (this is meant to provide implicit TypeMappers)
- preamble
Text to add to the generated scala file. This can be used only when single_file is true.
- singleFile
If true, all messages and enums (but not services) will be written to a single Scala file.
- noPrimitiveWrappers
By default, wrappers defined at https://github.com/google/protobuf/blob/master/src/google/protobuf/wrappers.proto, are mapped to an Option[T] where T is a primitive type. When this field is set to true, we do not perform this transformation.
- primitiveWrappers
DEPRECATED. In ScalaPB <= 0.5.47, it was necessary to explicitly enable primitive_wrappers. This field remains here for backwards compatibility, but it has no effect on generated code. It is an error to set both
primitive_wrappers
andno_primitive_wrappers
.- collectionType
Scala type to be used for repeated fields. If unspecified,
scala.collection.Seq
will be used.- preserveUnknownFields
If set to true, all generated messages in this file will preserve unknown fields.
- objectName
If defined, sets the name of the file-level object that would be generated. This object extends
GeneratedFileObject
and contains descriptors, and list of message and enum companions.- scope
Experimental: scope to apply the given options.
- lenses
If true, lenses will be generated.
- retainSourceCodeInfo
If true, then source-code info information will be included in the generated code - normally the source code info is cleared out to reduce code size. The source code info is useful for extracting source code location from the descriptors as well as comments.
- mapType
Scala type to be used for maps. If unspecified,
scala.collection.immutable.Map
will be used.- noDefaultValuesInConstructor
If true, no default values will be generated in message constructors.
- testOnlyNoJavaConversions
For use in tests only. Inhibit Java conversions even when when generator parameters request for it.
- Annotations
- @SerialVersionUID()
- final class Scalapb extends AnyRef
Value Members
- object EnumOptions extends GeneratedMessageCompanion[EnumOptions] with Serializable
- object EnumValueOptions extends GeneratedMessageCompanion[EnumValueOptions] with Serializable
- object FieldOptions extends GeneratedMessageCompanion[FieldOptions] with Serializable
- object MessageOptions extends GeneratedMessageCompanion[MessageOptions] with Serializable
- object OneofOptions extends GeneratedMessageCompanion[OneofOptions] with Serializable
- object ScalaPbOptions extends GeneratedMessageCompanion[ScalaPbOptions] with Serializable
- object ScalapbProto extends GeneratedFileObject