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 = _root_.scalapb.UnknownFieldSet.empty) 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_nameinto 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()
- Alphabetic
- By Inheritance
- MessageOptions
- ExtendableMessage
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new 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 = _root_.scalapb.UnknownFieldSet.empty)
- 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_nameinto 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.
Value Members
- final def !=(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): MessageOptions
- def addUninterpretedOption(__vs: UninterpretedOption*): MessageOptions
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearDeprecated: MessageOptions
- def clearDeprecatedLegacyJsonFieldConflicts: MessageOptions
- def clearFeatures: MessageOptions
- def clearMapEntry: MessageOptions
- def clearMessageSetWireFormat: MessageOptions
- def clearNoStandardDescriptorAccessor: MessageOptions
- def clearUninterpretedOption: MessageOptions
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: MessageOptions.type
- Definition Classes
- MessageOptions → GeneratedMessage
- val deprecated: scala.Option[Boolean]
- def discardUnknownFields: MessageOptions
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def extension[T](generatedExtension: GeneratedExtension[MessageOptions, T]): T
- Definition Classes
- ExtendableMessage
- val features: scala.Option[FeatureSet]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDeprecated: Boolean
- def getDeprecatedLegacyJsonFieldConflicts: Boolean
- def getFeatures: FeatureSet
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- MessageOptions → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): scala.Any
- Definition Classes
- MessageOptions → GeneratedMessage
- def getMapEntry: Boolean
- def getMessageSetWireFormat: Boolean
- def getNoStandardDescriptorAccessor: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mapEntry: scala.Option[Boolean]
- val messageSetWireFormat: scala.Option[Boolean]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noStandardDescriptorAccessor: scala.Option[Boolean]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- MessageOptions → 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
- MessageOptions → GeneratedMessage
- val uninterpretedOption: Seq[UninterpretedOption]
- val unknownFields: scalapb.UnknownFieldSet
- Definition Classes
- MessageOptions → ExtendableMessage
- def update(ms: (Lens[MessageOptions, MessageOptions]) => Mutation[MessageOptions]*): MessageOptions
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withDeprecated(__v: Boolean): MessageOptions
- def withDeprecatedLegacyJsonFieldConflicts(__v: Boolean): MessageOptions
- def withExtension[T](generatedExtension: GeneratedExtension[MessageOptions, T])(value: T): MessageOptions
- Definition Classes
- ExtendableMessage
- def withFeatures(__v: FeatureSet): MessageOptions
- def withMapEntry(__v: Boolean): MessageOptions
- def withMessageSetWireFormat(__v: Boolean): MessageOptions
- def withNoStandardDescriptorAccessor(__v: Boolean): MessageOptions
- def withUninterpretedOption(__v: Seq[UninterpretedOption]): MessageOptions
- def withUnknownFields(__v: scalapb.UnknownFieldSet): MessageOptions
- Definition Classes
- MessageOptions → ExtendableMessage
- 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
- MessageOptions → 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
Deprecated Value Members
- val deprecatedLegacyJsonFieldConflicts: scala.Option[Boolean]
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file