final case class FieldDescriptorProto(name: scala.Option[String] = _root_.scala.None, number: scala.Option[Int] = _root_.scala.None, label: scala.Option[Label] = _root_.scala.None, type: scala.Option[FieldDescriptorProto.Type] = _root_.scala.None, typeName: scala.Option[String] = _root_.scala.None, extendee: scala.Option[String] = _root_.scala.None, defaultValue: scala.Option[String] = _root_.scala.None, oneofIndex: scala.Option[Int] = _root_.scala.None, jsonName: scala.Option[String] = _root_.scala.None, options: scala.Option[FieldOptions] = _root_.scala.None, proto3Optional: scala.Option[Boolean] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FieldDescriptorProto] with Product with Serializable

Describes a field within a message.

type

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

typeName

For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

extendee

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

defaultValue

For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

oneofIndex

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

jsonName

JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

proto3Optional

If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL.

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[FieldDescriptorProto], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldDescriptorProto
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldDescriptorProto(name: scala.Option[String] = _root_.scala.None, number: scala.Option[Int] = _root_.scala.None, label: scala.Option[Label] = _root_.scala.None, type: scala.Option[FieldDescriptorProto.Type] = _root_.scala.None, typeName: scala.Option[String] = _root_.scala.None, extendee: scala.Option[String] = _root_.scala.None, defaultValue: scala.Option[String] = _root_.scala.None, oneofIndex: scala.Option[Int] = _root_.scala.None, jsonName: scala.Option[String] = _root_.scala.None, options: scala.Option[FieldOptions] = _root_.scala.None, proto3Optional: scala.Option[Boolean] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...)

    type

    If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

    typeName

    For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

    extendee

    For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

    defaultValue

    For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

    oneofIndex

    If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

    jsonName

    JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

    proto3Optional

    If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearDefaultValue: FieldDescriptorProto
  6. def clearExtendee: FieldDescriptorProto
  7. def clearJsonName: FieldDescriptorProto
  8. def clearLabel: FieldDescriptorProto
  9. def clearName: FieldDescriptorProto
  10. def clearNumber: FieldDescriptorProto
  11. def clearOneofIndex: FieldDescriptorProto
  12. def clearOptions: FieldDescriptorProto
  13. def clearProto3Optional: FieldDescriptorProto
  14. def clearType: FieldDescriptorProto
  15. def clearTypeName: FieldDescriptorProto
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def companion: FieldDescriptorProto.type
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  18. val defaultValue: scala.Option[String]
  19. def discardUnknownFields: FieldDescriptorProto
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. val extendee: scala.Option[String]
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def getDefaultValue: String
  25. def getExtendee: String
  26. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  27. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  28. def getJsonName: String
  29. def getLabel: Label
  30. def getName: String
  31. def getNumber: Int
  32. def getOneofIndex: Int
  33. def getOptions: FieldOptions
  34. def getProto3Optional: Boolean
  35. def getType: FieldDescriptorProto.Type
  36. def getTypeName: String
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. val jsonName: scala.Option[String]
  39. val label: scala.Option[Label]
  40. val name: scala.Option[String]
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. val number: scala.Option[Int]
  45. val oneofIndex: scala.Option[Int]
  46. val options: scala.Option[FieldOptions]
  47. val proto3Optional: scala.Option[Boolean]
  48. def serializedSize: Int
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. 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
  51. 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
  52. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  53. 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
    FieldDescriptorProto → GeneratedMessage
  54. val type: scala.Option[FieldDescriptorProto.Type]
  55. val typeName: scala.Option[String]
  56. val unknownFields: scalapb.UnknownFieldSet
  57. def update(ms: (Lens[FieldDescriptorProto, FieldDescriptorProto]) ⇒ Mutation[FieldDescriptorProto]*): FieldDescriptorProto
    Definition Classes
    Updatable
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  61. def withDefaultValue(__v: String): FieldDescriptorProto
  62. def withExtendee(__v: String): FieldDescriptorProto
  63. def withJsonName(__v: String): FieldDescriptorProto
  64. def withLabel(__v: Label): FieldDescriptorProto
  65. def withName(__v: String): FieldDescriptorProto
  66. def withNumber(__v: Int): FieldDescriptorProto
  67. def withOneofIndex(__v: Int): FieldDescriptorProto
  68. def withOptions(__v: FieldOptions): FieldDescriptorProto
  69. def withProto3Optional(__v: Boolean): FieldDescriptorProto
  70. def withType(__v: FieldDescriptorProto.Type): FieldDescriptorProto
  71. def withTypeName(__v: String): FieldDescriptorProto
  72. def withUnknownFields(__v: scalapb.UnknownFieldSet): FieldDescriptorProto
  73. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  74. 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
    FieldDescriptorProto → GeneratedMessage
  75. 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

Inherited from Updatable[FieldDescriptorProto]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped