final case class Field(kind: Kind = ..., cardinality: Cardinality = ..., number: Int = 0, name: String = "", typeUrl: String = "", oneofIndex: Int = 0, packed: Boolean = false, options: Seq[OptionProto] = _root_.scala.collection.Seq.empty, jsonName: String = "", defaultValue: String = "") extends scalapb.GeneratedMessage with scalapb.Message[Field] with Updatable[Field] with Product with Serializable
A single field of a message type.
- kind
The field type.
- cardinality
The field cardinality.
- number
The field number.
- name
The field name.
- typeUrl
The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".- oneofIndex
The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.- packed
Whether to use alternative packed wire representation.
- options
The protocol buffer options.
- jsonName
The field JSON name.
- defaultValue
The string value of the default value of this field. Proto2 syntax only.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- Field
- Product
- Equals
- Updatable
- Message
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Field(kind: Kind = ..., cardinality: Cardinality = ..., number: Int = 0, name: String = "", typeUrl: String = "", oneofIndex: Int = 0, packed: Boolean = false, options: Seq[OptionProto] = _root_.scala.collection.Seq.empty, jsonName: String = "", defaultValue: String = "")
- kind
The field type.
- cardinality
The field cardinality.
- number
The field number.
- name
The field name.
- typeUrl
The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".- oneofIndex
The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.- packed
Whether to use alternative packed wire representation.
- options
The protocol buffer options.
- jsonName
The field JSON name.
- defaultValue
The string value of the default value of this field. Proto2 syntax only.
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
- def addAllOptions(__vs: TraversableOnce[OptionProto]): Field
- def addOptions(__vs: OptionProto*): Field
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val cardinality: Cardinality
- def clearOptions: Field
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
companion: Field.type
- Definition Classes
- Field → GeneratedMessage
- val defaultValue: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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
getField(__field: FieldDescriptor): PValue
- Definition Classes
- Field → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): scala.Any
- Definition Classes
- Field → GeneratedMessage
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jsonName: String
- val kind: Kind
- def mergeFrom(_input__: CodedInputStream): Field
- val name: 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: Int
- val oneofIndex: Int
- val options: Seq[OptionProto]
- val packed: Boolean
-
final
def
serializedSize: Int
- Definition Classes
- Field → 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
- Field → AnyRef → Any
- val typeUrl: String
-
def
update(ms: (Lens[Field, Field]) ⇒ Mutation[Field]*): Field
- 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 withCardinality(__v: Cardinality): Field
- def withDefaultValue(__v: String): Field
- def withJsonName(__v: String): Field
- def withKind(__v: Kind): Field
- def withName(__v: String): Field
- def withNumber(__v: Int): Field
- def withOneofIndex(__v: Int): Field
- def withOptions(__v: Seq[OptionProto]): Field
- def withPacked(__v: Boolean): Field
- def withTypeUrl(__v: String): Field
-
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Field → 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