Packages

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.Vector.empty, jsonName: String = "", defaultValue: String = "", unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[Field] with Product with Serializable

A single field of a message type.

New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

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()
Linear Supertypes
Updatable[Field], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Field
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Field(kind: Kind = ..., cardinality: Cardinality = ..., number: Int = 0, name: String = "", typeUrl: String = "", oneofIndex: Int = 0, packed: Boolean = false, options: Seq[OptionProto] = _root_.scala.Vector.empty, jsonName: String = "", defaultValue: String = "", unknownFields: scalapb.UnknownFieldSet = ...)

    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

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllOptions(__vs: Iterable[OptionProto]): Field
  5. def addOptions(__vs: OptionProto*): Field
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val cardinality: Cardinality
  8. def clearOptions: Field
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def companion: Field.type
    Definition Classes
    Field → GeneratedMessage
  11. val defaultValue: String
  12. def discardUnknownFields: Field
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Field → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    Field → GeneratedMessage
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val jsonName: String
  20. val kind: Kind
  21. val name: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val number: Int
  26. val oneofIndex: Int
  27. val options: Seq[OptionProto]
  28. val packed: Boolean
  29. def serializedSize: Int
    Definition Classes
    Field → GeneratedMessage
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. final def toByteArray: Array[Byte]

    Serializes the message and returns a byte array containing its raw bytes

    Serializes the message and returns a byte array containing its raw bytes

    Definition Classes
    GeneratedMessage
  32. final def toByteString: ByteString

    Serializes the message and returns a ByteString containing its raw bytes

    Serializes the message and returns a ByteString containing its raw bytes

    Definition Classes
    GeneratedMessage
  33. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  34. 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
    Field → GeneratedMessage
  35. val typeUrl: String
  36. val unknownFields: scalapb.UnknownFieldSet
  37. def update(ms: (Lens[Field, Field]) ⇒ Mutation[Field]*): Field
    Definition Classes
    Updatable
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  41. def withCardinality(__v: Cardinality): Field
  42. def withDefaultValue(__v: String): Field
  43. def withJsonName(__v: String): Field
  44. def withKind(__v: Kind): Field
  45. def withName(__v: String): Field
  46. def withNumber(__v: Int): Field
  47. def withOneofIndex(__v: Int): Field
  48. def withOptions(__v: Seq[OptionProto]): Field
  49. def withPacked(__v: Boolean): Field
  50. def withTypeUrl(__v: String): Field
  51. def withUnknownFields(__v: scalapb.UnknownFieldSet): Field
  52. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  53. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

    Definition Classes
    Field → GeneratedMessage
  54. final def writeTo(output: OutputStream): Unit

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Inherited from Updatable[Field]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped