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 &#64;type
field. Example (for message [google.protobuf.Duration][]):

{
  "&#64;type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Generated from protobuf message google.protobuf.Any

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Constants
public Google\Protobuf\Any::TYPE_URL_PREFIX = 'type.googleapis.com/'
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getTypeUrl()
     

    A URL/resource name that uniquely identifies the type of the serialized
    protocol buffer message. 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.

    Generated from protobuf field string type_url = 1;

    • return string
    public getValue()
     

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

    Generated from protobuf field bytes value = 2;

    • return string
    public is( $klass)
     

    This method returns whether the type_url in any_message is corresponded
    to the given class.

      public Google\Protobuf\Internal\Message::jsonByteSize()
       
      • ignore
      public Google\Protobuf\Internal\Message::mergeFrom( $msg)
       

      Merges the contents of the specified message into current message.

      This method merges the contents of the specified message into the
      current message. Singular fields that are set in the specified message
      overwrite the corresponding fields in the current message. Repeated
      fields are appended. Map fields key-value pairs are overwritten.
      Singular/Oneof sub-messages are recursively merged. All overwritten
      sub-messages are deep-copied.

      • return
      public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
       

      Parses a json string to protobuf message.

      This function takes a string in the json wire format, matching the
      encoding output by serializeToJsonString().
      See mergeFrom() for merging behavior, if the field is already set in the
      specified message.

      • return
      • throws Exception Invalid data.
      public Google\Protobuf\Internal\Message::mergeFromString( $data)
       

      Parses a protocol buffer contained in a string.

      This function takes a string in the (non-human-readable) binary wire
      format, matching the encoding output by serializeToString().
      See mergeFrom() for merging behavior, if the field is already set in the
      specified message.

      • return
      • throws Exception Invalid data.
      public pack( $msg)
       

      The type_url will be created according to the given message’s type and
      the value is encoded data from the given message.

      .

        public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
         
        • ignore
        public Google\Protobuf\Internal\Message::parseFromStream( $input)
         
        • ignore
        public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
         
        • ignore
        public Google\Protobuf\Internal\Message::serializeToJsonString()
         

        Serialize the message to json string.

        • return string Serialized json protobuf data.
        public Google\Protobuf\Internal\Message::serializeToStream( $output)
         
        • ignore
        public Google\Protobuf\Internal\Message::serializeToString()
         

        Serialize the message to string.

        • return string Serialized binary protobuf data.
        public setTypeUrl( $var)
         

        A URL/resource name that uniquely identifies the type of the serialized
        protocol buffer message. 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.

        Generated from protobuf field string type_url = 1;

        • return $this
        public setValue( $var)
         

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

        Generated from protobuf field bytes value = 2;

        • return $this
        public unpack()
         

        This method will try to resolve the type_url in Any message to get the
        targeted message type. If failed, an error will be thrown. Otherwise,
        the method will create a message of the targeted type and fill it with
        the decoded value in Any.

        • return Message unpacked message
        • throws Exception Type url needs to be type.googleapis.com/fully-qualified.
        • throws Exception Class hasn't been added to descriptor pool.
        • throws Exception cannot decode data in value field.
        Methods
        protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
         

        Populates the message from a user-supplied PHP array. Array keys
        correspond to Message properties and nested message properties.

        Example:

        $message->mergeFromArray([
            'name' => 'This is a message name',
            'interval' => [
                 'startTime' => time() - 60,
                 'endTime' => time(),
            ]
        ]);
        

        This method will trigger an error if it is passed data that cannot
        be converted to the correct type. For example, a StringValue field
        must receive data that is either a string or a StringValue object.

        • return
        protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
        protected Google\Protobuf\Internal\Message::readOneof( $number)
        protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
        protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
        protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
        protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
        Properties
        private $type_url
         

        A URL/resource name that uniquely identifies the type of the serialized
        protocol buffer message. 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.

        Generated from protobuf field string type_url = 1;

        private $value
         

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

        Generated from protobuf field bytes value = 2;

        Methods
        private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
        private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
        private Google\Protobuf\Internal\Message::defaultValue( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::existField( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::fieldByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
         
        • ignore
        private Google\Protobuf\Internal\Message::initWithGeneratedPool()
         
        • ignore
        private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
        private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
             
            • ignore
            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
             
            • ignore
            private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
             
            • ignore
            private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
             
            • ignore
            private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
             
            • ignore
            private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
             
            • ignore
            private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
             
            • ignore
            private Google\Protobuf\Internal\Message::skipField( $input, $tag)
             
            • ignore
            Methods
            private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
             

            Tries to normalize the elements in $value into a provided protobuf
            wrapper type $class. If $value is any type other than array, we do
            not do any conversion, and instead rely on the existing protobuf
            type checking. If $value is an array, we process each element and
            try to convert it to an instance of $class.

              private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
               

              Tries to normalize $value into a provided protobuf wrapper type $class.

              If $value is any type other than an object, we attempt to construct an
              instance of $class and assign $value to it using the setValue method
              shared by all wrapper types.

              This method will raise an error if it receives a type that cannot be
              assigned to the wrapper type via setValue.

                private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
                 
                • ignore
                © 2020 Bruce Wells
                Search Namespaces \ Classes
                ConfigurationNumbers (0-9.) only