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()
Linear Supertypes
ExtendableMessage[MessageOptions], Updatable[MessageOptions], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageOptions
  2. ExtendableMessage
  3. Updatable
  4. GeneratedMessage
  5. Serializable
  6. Serializable
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    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.

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): MessageOptions
  5. def addUninterpretedOption(__vs: UninterpretedOption*): MessageOptions
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearDeprecated: MessageOptions
  8. def clearDeprecatedLegacyJsonFieldConflicts: MessageOptions
  9. def clearFeatures: MessageOptions
  10. def clearMapEntry: MessageOptions
  11. def clearMessageSetWireFormat: MessageOptions
  12. def clearNoStandardDescriptorAccessor: MessageOptions
  13. def clearUninterpretedOption: MessageOptions
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def companion: MessageOptions.type
    Definition Classes
    MessageOptions → GeneratedMessage
  16. val deprecated: scala.Option[Boolean]
  17. def discardUnknownFields: MessageOptions
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def extension[T](generatedExtension: GeneratedExtension[MessageOptions, T]): T
    Definition Classes
    ExtendableMessage
  20. val features: scala.Option[FeatureSet]
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getDeprecated: Boolean
  24. def getDeprecatedLegacyJsonFieldConflicts: Boolean
  25. def getFeatures: FeatureSet
  26. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    MessageOptions → GeneratedMessage
  27. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    MessageOptions → GeneratedMessage
  28. def getMapEntry: Boolean
  29. def getMessageSetWireFormat: Boolean
  30. def getNoStandardDescriptorAccessor: Boolean
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. val mapEntry: scala.Option[Boolean]
  33. val messageSetWireFormat: scala.Option[Boolean]
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. val noStandardDescriptorAccessor: scala.Option[Boolean]
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def serializedSize: Int
    Definition Classes
    MessageOptions → GeneratedMessage
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. 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
  41. 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
  42. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  43. 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
  44. val uninterpretedOption: Seq[UninterpretedOption]
  45. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    MessageOptions → ExtendableMessage
  46. def update(ms: (Lens[MessageOptions, MessageOptions]) ⇒ Mutation[MessageOptions]*): MessageOptions
    Definition Classes
    Updatable
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  50. def withDeprecated(__v: Boolean): MessageOptions
  51. def withDeprecatedLegacyJsonFieldConflicts(__v: Boolean): MessageOptions
  52. def withExtension[T](generatedExtension: GeneratedExtension[MessageOptions, T])(value: T): MessageOptions
    Definition Classes
    ExtendableMessage
  53. def withFeatures(__v: FeatureSet): MessageOptions
  54. def withMapEntry(__v: Boolean): MessageOptions
  55. def withMessageSetWireFormat(__v: Boolean): MessageOptions
  56. def withNoStandardDescriptorAccessor(__v: Boolean): MessageOptions
  57. def withUninterpretedOption(__v: Seq[UninterpretedOption]): MessageOptions
  58. def withUnknownFields(__v: scalapb.UnknownFieldSet): MessageOptions
    Definition Classes
    MessageOptions → ExtendableMessage
  59. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  60. 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
  61. 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

  1. val deprecatedLegacyJsonFieldConflicts: scala.Option[Boolean]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from ExtendableMessage[MessageOptions]

Inherited from Updatable[MessageOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped