Class/Object

com.google.protobuf.descriptor

FieldDescriptorProto

Related Docs: object FieldDescriptorProto | package descriptor

Permalink

final case class FieldDescriptorProto(name: Option[String] = None, number: Option[Int] = None, label: Option[Label] = None, type: Option[Type] = None, typeName: Option[String] = None, extendee: Option[String] = None, defaultValue: Option[String] = None, oneofIndex: Option[Int] = None, jsonName: Option[String] = None, options: Option[FieldOptions] = 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, 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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clearDefaultValue: FieldDescriptorProto

    Permalink
  6. def clearExtendee: FieldDescriptorProto

    Permalink
  7. def clearJsonName: FieldDescriptorProto

    Permalink
  8. def clearLabel: FieldDescriptorProto

    Permalink
  9. def clearName: FieldDescriptorProto

    Permalink
  10. def clearNumber: FieldDescriptorProto

    Permalink
  11. def clearOneofIndex: FieldDescriptorProto

    Permalink
  12. def clearOptions: FieldDescriptorProto

    Permalink
  13. def clearType: FieldDescriptorProto

    Permalink
  14. def clearTypeName: FieldDescriptorProto

    Permalink
  15. def clone(): AnyRef

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

    Permalink
    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  17. val defaultValue: Option[String]

    Permalink

    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?

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

    Permalink
    Definition Classes
    AnyRef
  19. val extendee: Option[String]

    Permalink

    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.

  20. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. def getDefaultValue: String

    Permalink
  23. def getExtendee: String

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

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

    Permalink
    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  26. def getJsonName: String

    Permalink
  27. def getLabel: Label

    Permalink
  28. def getName: String

    Permalink
  29. def getNumber: Int

    Permalink
  30. def getOneofIndex: Int

    Permalink
  31. def getOptions: FieldOptions

    Permalink
  32. def getType: Type

    Permalink
  33. def getTypeName: String

    Permalink
  34. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  35. val jsonName: Option[String]

    Permalink

    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.

  36. val label: Option[Label]

    Permalink
  37. def mergeFrom(_input__: CodedInputStream): FieldDescriptorProto

    Permalink
    Definition Classes
    FieldDescriptorProtoMessage
  38. val name: Option[String]

    Permalink
  39. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  40. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  42. val number: Option[Int]

    Permalink
  43. val oneofIndex: Option[Int]

    Permalink

    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.

  44. val options: Option[FieldOptions]

    Permalink
  45. final def serializedSize: Int

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

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

    Permalink
    Definition Classes
    GeneratedMessage
  48. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  49. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  50. 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
    FieldDescriptorProtoGeneratedMessage
  51. val type: Option[Type]

    Permalink

    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.

  52. val typeName: Option[String]

    Permalink

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

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

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

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

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

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

    Permalink
  58. def withExtendee(__v: String): FieldDescriptorProto

    Permalink
  59. def withJsonName(__v: String): FieldDescriptorProto

    Permalink
  60. def withLabel(__v: Label): FieldDescriptorProto

    Permalink
  61. def withName(__v: String): FieldDescriptorProto

    Permalink
  62. def withNumber(__v: Int): FieldDescriptorProto

    Permalink
  63. def withOneofIndex(__v: Int): FieldDescriptorProto

    Permalink
  64. def withOptions(__v: FieldOptions): FieldDescriptorProto

    Permalink
  65. def withType(__v: Type): FieldDescriptorProto

    Permalink
  66. def withTypeName(__v: String): FieldDescriptorProto

    Permalink
  67. def writeDelimitedTo(output: OutputStream): Unit

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

    Permalink
    Definition Classes
    FieldDescriptorProtoGeneratedMessage
  69. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    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.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped