final case class FieldDescriptorProto(name: scala.Option[String] = None, number: scala.Option[Int] = None, label: scala.Option[Label] = None, type: scala.Option[FieldDescriptorProto.Type] = None, typeName: scala.Option[String] = None, extendee: scala.Option[String] = None, defaultValue: scala.Option[String] = None, oneofIndex: scala.Option[Int] = None, jsonName: scala.Option[String] = None, options: scala.Option[FieldOptions] = 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()
- Alphabetic
- By Inheritance
- FieldDescriptorProto
- Product
- Equals
- Updatable
- Message
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
FieldDescriptorProto(name: scala.Option[String] = None, number: scala.Option[Int] = None, label: scala.Option[Label] = None, type: scala.Option[FieldDescriptorProto.Type] = None, typeName: scala.Option[String] = None, extendee: scala.Option[String] = None, defaultValue: scala.Option[String] = None, oneofIndex: scala.Option[Int] = None, jsonName: scala.Option[String] = None, options: scala.Option[FieldOptions] = 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
-
final
def
!=(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearDefaultValue: FieldDescriptorProto
- def clearExtendee: FieldDescriptorProto
- def clearJsonName: FieldDescriptorProto
- def clearLabel: FieldDescriptorProto
- def clearName: FieldDescriptorProto
- def clearNumber: FieldDescriptorProto
- def clearOneofIndex: FieldDescriptorProto
- def clearOptions: FieldDescriptorProto
- def clearType: FieldDescriptorProto
- def clearTypeName: FieldDescriptorProto
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
companion: FieldDescriptorProto.type
- Definition Classes
- FieldDescriptorProto → GeneratedMessage
- val defaultValue: scala.Option[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val extendee: scala.Option[String]
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- def getDefaultValue: String
- def getExtendee: String
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- FieldDescriptorProto → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): scala.Any
- Definition Classes
- FieldDescriptorProto → GeneratedMessage
- def getJsonName: String
- def getLabel: Label
- def getName: String
- def getNumber: Int
- def getOneofIndex: Int
- def getOptions: FieldOptions
- def getType: FieldDescriptorProto.Type
- def getTypeName: String
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jsonName: scala.Option[String]
- val label: scala.Option[Label]
-
def
mergeFrom(_input__: CodedInputStream): FieldDescriptorProto
- Definition Classes
- FieldDescriptorProto → Message
- val name: scala.Option[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val number: scala.Option[Int]
- val oneofIndex: scala.Option[Int]
- val options: scala.Option[FieldOptions]
-
final
def
serializedSize: Int
- Definition Classes
- FieldDescriptorProto → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
-
def
toByteString: ByteString
- Definition Classes
- GeneratedMessage
-
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toString(): String
- Definition Classes
- FieldDescriptorProto → AnyRef → Any
- val type: scala.Option[FieldDescriptorProto.Type]
- val typeName: scala.Option[String]
-
def
update(ms: (Lens[FieldDescriptorProto, FieldDescriptorProto]) ⇒ Mutation[FieldDescriptorProto]*): FieldDescriptorProto
- Definition Classes
- Updatable
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def withDefaultValue(__v: String): FieldDescriptorProto
- def withExtendee(__v: String): FieldDescriptorProto
- def withJsonName(__v: String): FieldDescriptorProto
- def withLabel(__v: Label): FieldDescriptorProto
- def withName(__v: String): FieldDescriptorProto
- def withNumber(__v: Int): FieldDescriptorProto
- def withOneofIndex(__v: Int): FieldDescriptorProto
- def withOptions(__v: FieldOptions): FieldDescriptorProto
- def withType(__v: FieldDescriptorProto.Type): FieldDescriptorProto
- def withTypeName(__v: String): FieldDescriptorProto
-
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- FieldDescriptorProto → GeneratedMessage
-
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
-
def
getAllFields: Map[FieldDescriptor, scala.Any]
- Definition Classes
- GeneratedMessage
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use toPMessage
-
def
getField(field: FieldDescriptor): scala.Any
- Definition Classes
- GeneratedMessage
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue