Google.Protobuf.WellKnownTypes.Any

public sealed class Any : IMessage<Any>, IMessage, IEquatable<Any>, IDeepCloneable<Any>, IBufferMessage

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. In its binary encoding, an `Any` is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the `type_url` field. Protobuf APIs provide utilities to interact with `Any` values: - A 'pack' operation accepts a message and constructs a generic `Any` wrapper around it. - An 'unpack' operation reads the content of an `Any` message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared `type_url`. - An 'is' operation decides whether an `Any` contains a message of the given type, i.e. whether it can 'unpack' that type. The JSON format representation of an `Any` follows one of these cases: - For types without special-cased JSON encodings, the JSON format representation of the `Any` is the same as that of the message, with an additional `@type` field which contains the type URL. - For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key `@type` which contains the type URL and a key `value` which contains the JSON-serialized value. The text format representation of an `Any` is like a message with one field whose name is the type URL in brackets. For example, an `Any` containing a `foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`.

public const int TypeUrlFieldNumber = 1

Field number for the "type_url" field.

public const int ValueFieldNumber = 2

Field number for the "value" field.

public static MessageDescriptor Descriptor { get; }

public static MessageParser<Any> Parser { get; }

public string TypeUrl { get; set; }

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one `/` character, and the content after the last `/` must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last `/` to identify the type. `type.googleapis.com/` is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, `type.googleapis.com%2FFoo` should be rejected. In the original design of `Any`, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

public ByteString Value { get; set; }

Holds a Protobuf serialization of the type described by type_url.

public Any()

public Any(Any other)

public static string GetTypeName(string typeUrl)

Retrieves the type name for a type URL, matching the FullName of the packed message type.

public static Any Pack(IMessage message)

Packs the specified message into an Any message using a type URL prefix of "type.googleapis.com".

public static Any Pack(IMessage message, string typeUrlPrefix)

Packs the specified message into an Any message using the specified type URL prefix.

public int CalculateSize()

public Any Clone()

public bool Equals(Any other)

public bool Is(MessageDescriptor descriptor)

Returns a bool indictating whether this Any message is of the target message type

public void MergeFrom(Any other)

public void MergeFrom(CodedInputStream input)

public bool TryUnpack<T>(out T result) where T : IMessage

Attempts to unpack the content of this Any message into the target message type, if it matches the type URL within this Any message.

public T Unpack<T>() where T : IMessage

Unpacks the content of this Any message into the target message type, which must match the type URL within this Any message.

public IMessage Unpack(TypeRegistry registry)

Attempts to unpack the content of this Any message into one of the message types in the given type registry, based on the type URL.

public void WriteTo(CodedOutputStream output)