final case class FieldDescriptorProto(name: Option[String] = _root_.scala.None, number: Option[Int] = _root_.scala.None, label: Option[Label] = _root_.scala.None, type: Option[Type] = _root_.scala.None, typeName: Option[String] = _root_.scala.None, extendee: Option[String] = _root_.scala.None, defaultValue: Option[String] = _root_.scala.None, oneofIndex: Option[Int] = _root_.scala.None, jsonName: Option[String] = _root_.scala.None, options: Option[FieldOptions] = _root_.scala.None) extends scalapb.GeneratedMessage with scalapb.Message[FieldDescriptorProto] 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. TODO(kenton): Base-64 encode?

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.

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

Instance Constructors

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

    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. TODO(kenton): Base-64 encode?

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: 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 clearType: FieldDescriptorProto
  14. def clearTypeName: FieldDescriptorProto
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  16. def companion: FieldDescriptorProto
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  17. val defaultValue: Option[String]
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val extendee: Option[String]
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def getDefaultValue: String
  22. def getExtendee: String
  23. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  24. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  25. def getJsonName: String
  26. def getLabel: Label
  27. def getName: String
  28. def getNumber: Int
  29. def getOneofIndex: Int
  30. def getOptions: FieldOptions
  31. def getType: Type
  32. def getTypeName: String
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. val jsonName: Option[String]
  35. val label: Option[Label]
  36. def mergeFrom(_input__: CodedInputStream): FieldDescriptorProto
    Definition Classes
    FieldDescriptorProto → Message
  37. val name: Option[String]
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. val number: Option[Int]
  42. val oneofIndex: Option[Int]
  43. val options: Option[FieldOptions]
  44. def productElementNames: Iterator[String]
    Definition Classes
    Product
  45. final def serializedSize: Int
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  48. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  49. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  50. 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
  51. val type: Option[Type]
  52. val typeName: Option[String]
  53. def update(ms: (Lens[FieldDescriptorProto, FieldDescriptorProto]) => Mutation[FieldDescriptorProto]*): FieldDescriptorProto
    Definition Classes
    Updatable
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. def withDefaultValue(__v: String): FieldDescriptorProto
  58. def withExtendee(__v: String): FieldDescriptorProto
  59. def withJsonName(__v: String): FieldDescriptorProto
  60. def withLabel(__v: Label): FieldDescriptorProto
  61. def withName(__v: String): FieldDescriptorProto
  62. def withNumber(__v: Int): FieldDescriptorProto
  63. def withOneofIndex(__v: Int): FieldDescriptorProto
  64. def withOptions(__v: FieldOptions): FieldDescriptorProto
  65. def withType(__v: Type): FieldDescriptorProto
  66. def withTypeName(__v: String): FieldDescriptorProto
  67. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  68. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    FieldDescriptorProto → GeneratedMessage
  69. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def getAllFields: Map[FieldDescriptor, Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  3. 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[FieldDescriptorProto]

Inherited from scalapb.Message[FieldDescriptorProto]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped