options

Type Members

1. final case class EnumOptions(extends: Seq[String] = _root_.scala.collection.Seq.empty, companionExtends: Seq[String] = _root_.scala.collection.Seq.empty, type: Option[String] = None) 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()

2. final case class EnumValueOptions(extends: Seq[String] = _root_.scala.collection.Seq.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.

   Annotations

   @SerialVersionUID()

3. final case class FieldOptions(type: Option[String] = None, scalaName: Option[String] = None, collectionType: Option[String] = None, keyType: Option[String] = None, valueType: Option[String] = None, annotations: Seq[String] = _root_.scala.collection.Seq.empty, noBox: Option[Boolean] = None) 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 to scala.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.

   noBox

   Do not box this value in Option[T]

   Annotations

   @SerialVersionUID()

4. final case class MessageOptions(extends: Seq[String] = _root_.scala.collection.Seq.empty, companionExtends: Seq[String] = _root_.scala.collection.Seq.empty, annotations: Seq[String] = _root_.scala.collection.Seq.empty, type: Option[String] = None, companionAnnotations: Seq[String] = _root_.scala.collection.Seq.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.

   Annotations

   @SerialVersionUID()

5. final case class OneofOptions(extends: Seq[String] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[OneofOptions] with Updatable[OneofOptions] with Product with Serializable

   
   extends

   Additional traits to mix in to a oneof.

   Annotations

   @SerialVersionUID()

6. final case class ScalaPbOptions(packageName: Option[String] = None, flatPackage: Option[Boolean] = None, import: Seq[String] = _root_.scala.collection.Seq.empty, preamble: Seq[String] = _root_.scala.collection.Seq.empty, singleFile: Option[Boolean] = None, noPrimitiveWrappers: Option[Boolean] = None, primitiveWrappers: Option[Boolean] = None, collectionType: Option[String] = None, preserveUnknownFields: Option[Boolean] = None, testOnlyNoJavaConversions: Option[Boolean] = None) 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 and no_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.

   testOnlyNoJavaConversions

   For use in tests only. Inhibit Java conversions even when when generator parameters request for it.

   Annotations

   @SerialVersionUID()