Struct

Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.

The JSON representation for Struct is JSON object.

fields: Unordered map of dynamically typed values.

Annotations: @SerialVersionUID()

Linear Supertypes

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

Instance Constructors

new Struct(fields: Map[String, Value] = ...)

fields
Unordered map of dynamically typed values.

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 addAllFields(__vs: TraversableOnce[(String, Value)]): Struct
def addFields(__vs: (String, Value)*): Struct
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearFields: Struct
def clone(): AnyRef

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

Definition Classes
Struct → GeneratedMessage
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val fields: Map[String, Value]

Unordered map of dynamically typed values.
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
Struct → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

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

Definition Classes
Any
def mergeFrom(_input__: CodedInputStream): Struct

Definition Classes
Struct → Message
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def serializedSize: Int

Definition Classes
Struct → 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
Struct → GeneratedMessage
def update(ms: (Lens[Struct, Struct]) ⇒ Mutation[Struct]*): Struct

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 withFields(__v: Map[String, Value]): Struct
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
Struct → 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 Struct | package struct

final case class Struct(fields: Map[String, Value] = ...) extends scalapb.GeneratedMessage with scalapb.Message[Struct] with Updatable[Struct] with Product with Serializable

Instance Constructors

new Struct(fields: Map[String, Value] = ...)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllFields(__vs: TraversableOnce[(String, Value)]): Struct

def addFields(__vs: (String, Value)*): Struct

final def asInstanceOf[T0]: T0

def clearFields: Struct

def clone(): AnyRef

def companion: Struct.type

final def eq(arg0: AnyRef): Boolean

val fields: Map[String, Value]

def finalize(): Unit

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

final def isInstanceOf[T0]: Boolean

def mergeFrom(_input__: CodedInputStream): Struct

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def serializedSize: Int

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

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withFields(__v: Map[String, Value]): Struct

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[Struct]

Inherited from scalapb.Message[Struct]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped