final case class FieldOptions(type: Option[String] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, collection: Option[Collection] = _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, noDefaultValueInConstructor: Option[Boolean] = _root_.scala.None, noBox: Option[Boolean] = _root_.scala.None, required: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[FieldOptions] with ExtendableMessage[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
- noDefaultValueInConstructor
If true, no default value will be generated for this field in the message constructor. If this field is set, it has the highest precedence and overrides the values at the message-level and file-level.
- noBox
Do not box this value in Option[T]. If set, this overrides MessageOptions.no_box
- required
Like no_box it does not box a value in Option[T], but also fails parsing when a value is not provided. This enables to emulate required fields in proto3.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- FieldOptions
- ExtendableMessage
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
FieldOptions(type: Option[String] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, collection: Option[Collection] = _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, noDefaultValueInConstructor: Option[Boolean] = _root_.scala.None, noBox: Option[Boolean] = _root_.scala.None, required: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)
- 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
- noDefaultValueInConstructor
If true, no default value will be generated for this field in the message constructor. If this field is set, it has the highest precedence and overrides the values at the message-level and file-level.
- noBox
Do not box this value in Option[T]. If set, this overrides MessageOptions.no_box
- required
Like no_box it does not box a value in Option[T], but also fails parsing when a value is not provided. This enables to emulate required fields in proto3.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllAnnotations(__vs: Iterable[String]): FieldOptions
- def addAnnotations(__vs: String*): FieldOptions
- val annotations: Seq[String]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearAnnotations: FieldOptions
- def clearCollection: FieldOptions
- def clearCollectionType: FieldOptions
- def clearKeyType: FieldOptions
- def clearMapType: FieldOptions
- def clearNoBox: FieldOptions
- def clearNoDefaultValueInConstructor: FieldOptions
- def clearRequired: FieldOptions
- def clearScalaName: FieldOptions
- def clearType: FieldOptions
- def clearValueType: FieldOptions
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val collection: Option[Collection]
- val collectionType: Option[String]
-
def
companion: FieldOptions.type
- Definition Classes
- FieldOptions → GeneratedMessage
- def discardUnknownFields: FieldOptions
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
extension[T](generatedExtension: GeneratedExtension[FieldOptions, T]): T
- Definition Classes
- ExtendableMessage
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getCollection: Collection
- def getCollectionType: String
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- FieldOptions → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- FieldOptions → GeneratedMessage
- def getKeyType: String
- def getMapType: String
- def getNoBox: Boolean
- def getNoDefaultValueInConstructor: Boolean
- def getRequired: Boolean
- def getScalaName: String
- def getType: String
- def getValueType: String
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val keyType: Option[String]
- val mapType: Option[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noBox: Option[Boolean]
- val noDefaultValueInConstructor: Option[Boolean]
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val required: Option[Boolean]
- val scalaName: Option[String]
-
def
serializedSize: Int
- Definition Classes
- FieldOptions → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toByteArray: Array[Byte]
Serializes the message and returns a byte array containing its raw bytes
Serializes the message and returns a byte array containing its raw bytes
- Definition Classes
- GeneratedMessage
-
final
def
toByteString: ByteString
Serializes the message and returns a ByteString containing its raw bytes
Serializes the message and returns a ByteString containing its raw bytes
- Definition Classes
- GeneratedMessage
-
final
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toProtoString: String
Returns a human-readable ASCII format representation of this message.
Returns a human-readable ASCII format representation of this message.
The original message can be decoded from this format by using fromAscii on the companion object.
- returns
human-readable representation of this message.
- Definition Classes
- FieldOptions → GeneratedMessage
- val type: Option[String]
-
val
unknownFields: UnknownFieldSet
- Definition Classes
- FieldOptions → ExtendableMessage
-
def
update(ms: (Lens[FieldOptions, FieldOptions]) ⇒ Mutation[FieldOptions]*): FieldOptions
- Definition Classes
- Updatable
- val valueType: Option[String]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withAnnotations(__v: Seq[String]): FieldOptions
- def withCollection(__v: Collection): FieldOptions
- def withCollectionType(__v: String): FieldOptions
-
def
withExtension[T](generatedExtension: GeneratedExtension[FieldOptions, T])(value: T): FieldOptions
- Definition Classes
- ExtendableMessage
- def withKeyType(__v: String): FieldOptions
- def withMapType(__v: String): FieldOptions
- def withNoBox(__v: Boolean): FieldOptions
- def withNoDefaultValueInConstructor(__v: Boolean): FieldOptions
- def withRequired(__v: Boolean): FieldOptions
- def withScalaName(__v: String): FieldOptions
- def withType(__v: String): FieldOptions
-
def
withUnknownFields(__v: UnknownFieldSet): FieldOptions
- Definition Classes
- FieldOptions → ExtendableMessage
- def withValueType(__v: String): FieldOptions
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
Serializes the message into the given coded output stream
Serializes the message into the given coded output stream
- Definition Classes
- FieldOptions → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
Serializes the message into the given output stream
Serializes the message into the given output stream
- Definition Classes
- GeneratedMessage