final case class Any(typeUrl: String = "", value: ByteString = ...) extends scalapb.GeneratedMessage with scalapb.Message[Any] 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) ...
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 whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme
http
,https
, or no scheme, the following restrictions and interpretations apply: * If no scheme is provided,https
is assumed. * The last segment of the URL's path must represent the fully qualified name of the type (as inpath/google.protobuf.Duration
). The name should be in a canonical form (e.g., leading "." is not accepted). * 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.) Schemes other thanhttp
,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()
- Alphabetic
- By Inheritance
- Any
- Product
- Equals
- AnyMethods
- Updatable
- Message
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Any(typeUrl: String = "", value: ByteString = ...)
- typeUrl
A URL/resource name whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme
http
,https
, or no scheme, the following restrictions and interpretations apply: * If no scheme is provided,https
is assumed. * The last segment of the URL's path must represent the fully qualified name of the type (as inpath/google.protobuf.Duration
). The name should be in a canonical form (e.g., leading "." is not accepted). * 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.) Schemes other thanhttp
,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
-
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
companion: Any.type
- Definition Classes
- Any → GeneratedMessage
-
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
- Annotations
- @native()
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- Any → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): scala.Any
- Definition Classes
- Any → GeneratedMessage
-
def
is[A <: scalapb.GeneratedMessage with scalapb.Message[A]](implicit cmp: GeneratedMessageCompanion[A]): Boolean
- Definition Classes
- AnyMethods
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mergeFrom(_input__: CodedInputStream): Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
serializedSize: Int
- Definition Classes
- Any → 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
- Any → GeneratedMessage
-
val
typeUrl: String
- Definition Classes
- Any → AnyMethods
-
def
unpack[A <: scalapb.GeneratedMessage with scalapb.Message[A]](implicit cmp: GeneratedMessageCompanion[A]): A
- Definition Classes
- AnyMethods
-
def
update(ms: (Lens[Any, Any]) ⇒ Mutation[Any]*): Any
- Definition Classes
- Updatable
-
val
value: ByteString
- Definition Classes
- Any → AnyMethods
-
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
- @native() @throws( ... )
- def withTypeUrl(__v: String): Any
- def withValue(__v: ByteString): Any
-
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Any → 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