class Any
Same name in this branch
- 11.1.x vendor/google/protobuf/src/GPBMetadata/Google/Protobuf/Any.php \GPBMetadata\Google\Protobuf\Any
- 11.1.x core/lib/Drupal/Core/TypedData/Plugin/DataType/Any.php \Drupal\Core\TypedData\Plugin\DataType\Any
`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); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } 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 := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(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" }
Generated from protobuf message <code>google.protobuf.Any</code>
Hierarchy
- class \Google\Protobuf\Internal\Message
Expanded class hierarchy of Any
9 string references to 'Any'
- ContextDefinition::dataTypeMatches in core/
lib/ Drupal/ Core/ Plugin/ Context/ ContextDefinition.php - Checks if this definition's data type matches that of the given context.
- DataDefinition::getDataType in core/
lib/ Drupal/ Core/ TypedData/ DataDefinition.php - Returns the data type of the data.
- FloatItem::fieldSettingsForm in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ FloatItem.php - Returns a form for the field-level settings.
- ListDataDefinition::createFromDataType in core/
lib/ Drupal/ Core/ TypedData/ ListDataDefinition.php - Creates a new data definition object.
- ListFloatItem::storageSettingsForm in core/
modules/ options/ src/ Plugin/ Field/ FieldType/ ListFloatItem.php - Returns a form for the storage-level settings.
File
-
vendor/
google/ protobuf/ src/ Google/ Protobuf/ Any.php, line 84
Namespace
Google\ProtobufView source
class Any extends \Google\Protobuf\Internal\AnyBase {
/**
* 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.
*
* Generated from protobuf field <code>string type_url = 1;</code>
*/
protected $type_url = '';
/**
* Must be a valid serialized protocol buffer of the above specified type.
*
* Generated from protobuf field <code>bytes value = 2;</code>
*/
protected $value = '';
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $type_url
* 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.
* @type string $value
* Must be a valid serialized protocol buffer of the above specified type.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Protobuf\Any::initOnce();
parent::__construct($data);
}
/**
* 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.
*
* Generated from protobuf field <code>string type_url = 1;</code>
* @return string
*/
public function getTypeUrl() {
return $this->type_url;
}
/**
* 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.
*
* Generated from protobuf field <code>string type_url = 1;</code>
* @param string $var
* @return $this
*/
public function setTypeUrl($var) {
GPBUtil::checkString($var, True);
$this->type_url = $var;
return $this;
}
/**
* Must be a valid serialized protocol buffer of the above specified type.
*
* Generated from protobuf field <code>bytes value = 2;</code>
* @return string
*/
public function getValue() {
return $this->value;
}
/**
* Must be a valid serialized protocol buffer of the above specified type.
*
* Generated from protobuf field <code>bytes value = 2;</code>
* @param string $var
* @return $this
*/
public function setValue($var) {
GPBUtil::checkString($var, False);
$this->value = $var;
return $this;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
Any::$type_url | protected | property | 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… |
|
Any::$value | protected | property | Must be a valid serialized protocol buffer of the above specified type. | |
Any::getTypeUrl | public | function | 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… |
|
Any::getValue | public | function | Must be a valid serialized protocol buffer of the above specified type. | |
Any::setTypeUrl | public | function | 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… |
|
Any::setValue | public | function | Must be a valid serialized protocol buffer of the above specified type. | |
Any::__construct | public | function | Constructor. | Overrides Message::__construct |
AnyBase::is | public | function | This method returns whether the type_url in any_message is corresponded to the given class. |
|
AnyBase::pack | public | function | The type_url will be created according to the given message’s type and the value is encoded data from the given message.. |
|
AnyBase::TYPE_URL_PREFIX | constant | |||
AnyBase::unpack | public | function | 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. |
|
Message::$desc | private | property | @ignore | |
Message::$unknown | private | property | ||
Message::appendHelper | private | function | ||
Message::byteSize | public | function | @ignore | |
Message::clear | public | function | Clear all containing fields. | |
Message::convertJsonValueToProtoValue | private | function | ||
Message::defaultValue | private | function | @ignore | |
Message::discardUnknownFields | public | function | Clear all unknown fields previously parsed. | |
Message::existField | private | function | @ignore | |
Message::fieldByteSize | private | function | @ignore | |
Message::fieldDataOnlyByteSize | private | function | @ignore | |
Message::fieldDataOnlyJsonByteSize | private | function | @ignore | |
Message::fieldJsonByteSize | private | function | @ignore | |
Message::hasOneof | protected | function | ||
Message::initWithDescriptor | private | function | @ignore | |
Message::initWithGeneratedPool | private | function | @ignore | |
Message::jsonByteSize | public | function | @ignore | |
Message::kvUpdateHelper | private | function | ||
Message::mergeFrom | public | function | Merges the contents of the specified message into current message. | |
Message::mergeFromArray | protected | function | Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties. |
|
Message::mergeFromArrayJsonImpl | private | function | ||
Message::mergeFromJsonArray | protected | function | ||
Message::mergeFromJsonString | public | function | Parses a json string to protobuf message. | |
Message::mergeFromString | public | function | Parses a protocol buffer contained in a string. | |
Message::normalizeArrayElementsToMessageType | private static | function | 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… |
|
Message::normalizeToMessageType | private static | function | 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. |
|
Message::parseFieldFromStream | private | function | @ignore | |
Message::parseFieldFromStreamNoTag | private static | function | @ignore | |
Message::parseFromJsonStream | public | function | @ignore | |
Message::parseFromStream | public | function | @ignore | |
Message::readOneof | protected | function | ||
Message::readWrapperValue | protected | function | ||
Message::repeatedFieldDataOnlyByteSize | private | function | @ignore | |
Message::serializeFieldToJsonStream | private | function | @ignore | |
Message::serializeFieldToStream | private | function | @ignore | |
Message::serializeMapFieldToStream | private | function | @ignore | |
Message::serializeRepeatedFieldToStream | private | function | @ignore | |
Message::serializeSingularFieldToStream | private | function | @ignore | |
Message::serializeToJsonStream | public | function | @ignore | |
Message::serializeToJsonString | public | function | Serialize the message to json string. | |
Message::serializeToStream | public | function | @ignore | |
Message::serializeToString | public | function | Serialize the message to string. | |
Message::skipField | private | function | @ignore | |
Message::whichOneof | protected | function | ||
Message::writeOneof | protected | function | ||
Message::writeWrapperValue | protected | function | ||
Message::__debugInfo | public | function |