com.google.protobuf.descriptor

MessageOptions

final case class MessageOptions(messageSetWireFormat: Option[Boolean] = scala.None, noStandardDescriptorAccessor: Option[Boolean] = scala.None, deprecated: Option[Boolean] = scala.None, mapEntry: Option[Boolean] = scala.None, uninterpretedOption: Seq[UninterpretedOption] = scala.collection.Seq.empty[Nothing], unknownFields: scalapb.UnknownFieldSet = ...) extends trueaccord.scalapb.GeneratedMessage with trueaccord.scalapb.Message[MessageOptions] 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 implementions 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.

uninterpretedOption

The parser stores options it doesn't recognize here. See above.

Annotations
@SerialVersionUID( 0L )
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MessageOptions
  2. Product
  3. Equals
  4. ExtendableMessage
  5. Updatable
  6. Message
  7. GeneratedMessage
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MessageOptions(messageSetWireFormat: Option[Boolean] = scala.None, noStandardDescriptorAccessor: Option[Boolean] = scala.None, deprecated: Option[Boolean] = scala.None, mapEntry: Option[Boolean] = scala.None, uninterpretedOption: Seq[UninterpretedOption] = scala.collection.Seq.empty[Nothing], 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 implementions 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.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See above.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): MessageOptions

  7. def addUninterpretedOption(__vs: UninterpretedOption*): MessageOptions

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clearDeprecated: MessageOptions

  10. def clearMapEntry: MessageOptions

  11. def clearMessageSetWireFormat: MessageOptions

  12. def clearNoStandardDescriptorAccessor: MessageOptions

  13. def clearUninterpretedOption: MessageOptions

  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def companion: MessageOptions.type

    Definition Classes
    MessageOptionsGeneratedMessage
  16. val deprecated: Option[Boolean]

    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.

  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def extension[T](generatedExtension: GeneratedExtension[MessageOptions, T]): T

    Definition Classes
    ExtendableMessage
  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def getDeprecated: Boolean

  22. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    MessageOptionsGeneratedMessage
  23. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    MessageOptionsGeneratedMessage
  24. def getMapEntry: Boolean

  25. def getMessageSetWireFormat: Boolean

  26. def getNoStandardDescriptorAccessor: Boolean

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. val mapEntry: Option[Boolean]

    Whether the message is an automatically generated map entry type for the maps field.

    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 implementions 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.

  29. def mergeFrom(_input__: CodedInputStream): MessageOptions

    Definition Classes
    MessageOptionsMessage
  30. val messageSetWireFormat: Option[Boolean]

    Set true to use the old proto1 MessageSet wire format for extensions.

    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.

  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  32. val noStandardDescriptorAccessor: Option[Boolean]

    Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name.

    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".

  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. final def serializedSize: Int

    Definition Classes
    MessageOptionsGeneratedMessage
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage
  38. def toByteString: ByteString

    Definition Classes
    GeneratedMessage
  39. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage
  40. def toString(): String

    Definition Classes
    MessageOptions → AnyRef → Any
  41. val uninterpretedOption: Seq[UninterpretedOption]

    The parser stores options it doesn't recognize here.

    The parser stores options it doesn't recognize here. See above.

  42. val unknownFields: scalapb.UnknownFieldSet

    Definition Classes
    MessageOptionsExtendableMessage
  43. def update(ms: (Lens[MessageOptions, MessageOptions]) ⇒ (MessageOptions) ⇒ MessageOptions*): MessageOptions

    Definition Classes
    Updatable
  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def withDeprecated(__v: Boolean): MessageOptions

  48. def withExtension[T](generatedExtension: GeneratedExtension[MessageOptions, T])(value: T): MessageOptions

    Definition Classes
    ExtendableMessage
  49. def withMapEntry(__v: Boolean): MessageOptions

  50. def withMessageSetWireFormat(__v: Boolean): MessageOptions

  51. def withNoStandardDescriptorAccessor(__v: Boolean): MessageOptions

  52. def withUninterpretedOption(__v: Seq[UninterpretedOption]): MessageOptions

  53. def withUnknownFields(__v: scalapb.UnknownFieldSet): MessageOptions

    Definition Classes
    MessageOptionsExtendableMessage
  54. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage
  55. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    MessageOptionsGeneratedMessage
  56. def writeTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[MessageOptions]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped