Class/Object

com.google.protobuf.descriptor

MessageOptions

Related Docs: object MessageOptions | package descriptor

Permalink

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, 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 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()
Linear Supertypes
Product, Equals, ExtendableMessage[MessageOptions], Updatable[MessageOptions], scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageOptions
  2. Product
  3. Equals
  4. ExtendableMessage
  5. Updatable
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  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, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...)

    Permalink

    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: scala.Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): MessageOptions

    Permalink
  5. def addUninterpretedOption(__vs: UninterpretedOption*): MessageOptions

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clearDeprecated: MessageOptions

    Permalink
  8. def clearMapEntry: MessageOptions

    Permalink
  9. def clearMessageSetWireFormat: MessageOptions

    Permalink
  10. def clearNoStandardDescriptorAccessor: MessageOptions

    Permalink
  11. def clearUninterpretedOption: MessageOptions

    Permalink
  12. def clone(): AnyRef

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

    Permalink
    Definition Classes
    MessageOptionsGeneratedMessage
  14. val deprecated: scala.Option[Boolean]

    Permalink

    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.

  15. def discardUnknownFields: MessageOptions

    Permalink
  16. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    ExtendableMessage
  18. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getDeprecated: Boolean

    Permalink
  21. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    MessageOptionsGeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): scala.Any

    Permalink
    Definition Classes
    MessageOptionsGeneratedMessage
  23. def getMapEntry: Boolean

    Permalink
  24. def getMessageSetWireFormat: Boolean

    Permalink
  25. def getNoStandardDescriptorAccessor: Boolean

    Permalink
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. val mapEntry: scala.Option[Boolean]

    Permalink

    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.

  28. val messageSetWireFormat: scala.Option[Boolean]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  30. val noStandardDescriptorAccessor: scala.Option[Boolean]

    Permalink

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

  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def serializedSize: Int

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

    Permalink
    Definition Classes
    AnyRef
  35. final def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  36. final def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  37. final def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  38. def toProtoString: String

    Permalink

    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
    MessageOptionsGeneratedMessage
  39. val uninterpretedOption: Seq[UninterpretedOption]

    Permalink

    The parser stores options it doesn't recognize here.

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

  40. val unknownFields: scalapb.UnknownFieldSet

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

    Permalink
    Definition Classes
    Updatable
  42. final def wait(): Unit

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

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

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

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

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

    Permalink
  48. def withMessageSetWireFormat(__v: Boolean): MessageOptions

    Permalink
  49. def withNoStandardDescriptorAccessor(__v: Boolean): MessageOptions

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

    Permalink
  51. def withUnknownFields(__v: scalapb.UnknownFieldSet): MessageOptions

    Permalink
    Definition Classes
    MessageOptionsExtendableMessage
  52. final def writeDelimitedTo(output: OutputStream): Unit

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

    Permalink
    Definition Classes
    MessageOptionsGeneratedMessage
  54. final def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[MessageOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped