Field

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

Linear Supertypes

Product, Equals, Updatable[Field], scalapb.Message[Field], scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any

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: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: 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

The field 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

The string value of the default value of this field.
The string value of the default value of this field. Proto2 syntax only.
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): Any

Definition Classes
Field → GeneratedMessage
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val jsonName: String

The field JSON name.
val kind: Kind

The field type.
def mergeFrom(_input__: CodedInputStream): Field

Definition Classes
Field → Message
val name: String

The field name.
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

The field number.
val oneofIndex: Int

The index of the field type in Type.oneofs, for message or enumeration types.
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.
val options: Seq[OptionProto]

The protocol buffer options.
val packed: Boolean

Whether to use alternative packed wire representation.
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 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
val typeUrl: String

The field type URL, without the scheme, for message or enumeration types.
The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".
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, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
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

Related Docs: object Field | package type

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 = "")

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllOptions(__vs: TraversableOnce[OptionProto]): Field

def addOptions(__vs: OptionProto*): Field

final def asInstanceOf[T0]: T0

val cardinality: Cardinality

def clearOptions: Field

def clone(): AnyRef

def companion: Field.type

val defaultValue: String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

final def isInstanceOf[T0]: Boolean

val jsonName: String

val kind: Kind

def mergeFrom(_input__: CodedInputStream): Field

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val number: Int

val oneofIndex: Int

val options: Seq[OptionProto]

val packed: Boolean

final def serializedSize: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

val typeUrl: String

def update(ms: (Lens[Field, Field]) ⇒ Mutation[Field]*): Field

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

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

def writeTo(_output__: CodedOutputStream): Unit

def writeTo(output: OutputStream): Unit

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

def getField(field: FieldDescriptor): Any

Inherited from Product

Inherited from Equals

Inherited from Updatable[Field]

Inherited from scalapb.Message[Field]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped