Packages

final case class Any(typeUrl: String = "", value: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends scalapb.GeneratedMessage with Updatable[Any] with AnyMethods with Product with Serializable

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

typeUrl

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

value

Must be a valid serialized protocol buffer of the above specified type.

Annotations
@SerialVersionUID()
Linear Supertypes
AnyMethods, Updatable[Any], scalapb.GeneratedMessage, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Any
  2. AnyMethods
  3. Updatable
  4. GeneratedMessage
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Any(typeUrl: String = "", value: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    typeUrl

    A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

    value

    Must be a valid serialized protocol buffer of the above specified type.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def companion: Any.type
    Definition Classes
    AnyGeneratedMessage
  7. def discardUnknownFields: Any
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    AnyGeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    AnyGeneratedMessage
  13. def is[A <: scalapb.GeneratedMessage](implicit cmp: GeneratedMessageCompanion[A]): Boolean
    Definition Classes
    AnyMethods
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. def serializedSize: Int
    Definition Classes
    AnyGeneratedMessage
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. 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
  22. 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
  23. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  24. 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
    AnyGeneratedMessage
  25. val typeUrl: String
    Definition Classes
    AnyAnyMethods
  26. val unknownFields: scalapb.UnknownFieldSet
  27. def unpack[A <: scalapb.GeneratedMessage](implicit cmp: GeneratedMessageCompanion[A]): A
    Definition Classes
    AnyMethods
  28. def update(ms: (Lens[Any, Any]) => Mutation[Any]*): Any
    Definition Classes
    Updatable
  29. val value: ByteString
    Definition Classes
    AnyAnyMethods
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. def withTypeUrl(__v: String): Any
  34. def withUnknownFields(__v: scalapb.UnknownFieldSet): Any
  35. def withValue(__v: ByteString): Any
  36. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  37. 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
    AnyGeneratedMessage
  38. 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 AnyMethods

Inherited from Updatable[Any]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped