com.google.protobuf.descriptor

FieldDescriptorProto

final case class FieldDescriptorProto(name: Option[String] = scala.None, number: Option[Int] = scala.None, label: Option[Label] = scala.None, type: Option[Type] = scala.None, typeName: Option[String] = scala.None, extendee: Option[String] = scala.None, defaultValue: Option[String] = scala.None, oneofIndex: Option[Int] = scala.None, jsonName: Option[String] = scala.None, options: Option[FieldOptions] = scala.None) extends trueaccord.scalapb.GeneratedMessage with trueaccord.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( 0L )
Linear Supertypes
Product, Equals, Updatable[FieldDescriptorProto], trueaccord.scalapb.Message[FieldDescriptorProto], trueaccord.scalapb.GeneratedMessage, Serializable, 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. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldDescriptorProto(name: Option[String] = scala.None, number: Option[Int] = scala.None, label: Option[Label] = scala.None, type: Option[Type] = scala.None, typeName: Option[String] = scala.None, extendee: Option[String] = scala.None, defaultValue: Option[String] = scala.None, oneofIndex: Option[Int] = scala.None, jsonName: Option[String] = scala.None, options: Option[FieldOptions] = 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: 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clearDefaultValue: FieldDescriptorProto

  8. def clearExtendee: FieldDescriptorProto

  9. def clearJsonName: FieldDescriptorProto

  10. def clearLabel: FieldDescriptorProto

  11. def clearName: FieldDescriptorProto

  12. def clearNumber: FieldDescriptorProto

  13. def clearOneofIndex: FieldDescriptorProto

  14. def clearOptions: FieldDescriptorProto

  15. def clearType: FieldDescriptorProto

  16. def clearTypeName: FieldDescriptorProto

  17. def clone(): AnyRef

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

    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  19. val defaultValue: Option[String]

    For numeric types, contains the original text representation of the value.

    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?

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

    Definition Classes
    AnyRef
  21. val extendee: Option[String]

    For extensions, this is the name of the type being extended.

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

  22. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  24. def getDefaultValue: String

  25. def getExtendee: String

  26. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  27. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  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 getType: Type

  35. def getTypeName: String

  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  37. val jsonName: Option[String]

    JSON name of this field.

    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.

  38. val label: Option[Label]

  39. def mergeFrom(_input__: CodedInputStream): FieldDescriptorProto

    Definition Classes
    FieldDescriptorProtoMessage
  40. val name: Option[String]

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

    Definition Classes
    AnyRef
  42. final def notify(): Unit

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

    Definition Classes
    AnyRef
  44. val number: Option[Int]

  45. val oneofIndex: Option[Int]

    If set, gives the index of a oneof in the containing type's oneof_decl list.

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

  46. val options: Option[FieldOptions]

  47. final def serializedSize: Int

    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  48. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Definition Classes
    GeneratedMessage
  50. def toByteString: ByteString

    Definition Classes
    GeneratedMessage
  51. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage
  52. def toString(): String

    Definition Classes
    FieldDescriptorProto → AnyRef → Any
  53. val type: Option[Type]

    If type_name is set, this need not be set.

    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.

  54. val typeName: Option[String]

    For message and enum types, this is the name of the type.

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

  55. def update(ms: (Lens[FieldDescriptorProto, FieldDescriptorProto]) ⇒ (FieldDescriptorProto) ⇒ FieldDescriptorProto*): FieldDescriptorProto

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def withDefaultValue(__v: String): FieldDescriptorProto

  60. def withExtendee(__v: String): FieldDescriptorProto

  61. def withJsonName(__v: String): FieldDescriptorProto

  62. def withLabel(__v: Label): FieldDescriptorProto

  63. def withName(__v: String): FieldDescriptorProto

  64. def withNumber(__v: Int): FieldDescriptorProto

  65. def withOneofIndex(__v: Int): FieldDescriptorProto

  66. def withOptions(__v: FieldOptions): FieldDescriptorProto

  67. def withType(__v: Type): FieldDescriptorProto

  68. def withTypeName(__v: String): FieldDescriptorProto

  69. def writeDelimitedTo(output: OutputStream): Unit

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

    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  71. 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[FieldDescriptorProto]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped