anypb

Documentation

Index

• Variables
• func MarshalFrom(dst *Any, src protobuf_go_lite.Message, typeURL string) error
• func UnmarshalNew(src *Any, typeURL string, resolver MessageTypeResolver) (dst protobuf_go_lite.Message, err error)
• func UnmarshalTo(src *Any, dst protobuf_go_lite.Message, typeURL string) error
• type Any
  • func New(src protobuf_go_lite.Message, typeURL string) (*Any, error)
  • func (m *Any) CloneMessageVT() protobuf_go_lite.CloneMessage
  • func (m *Any) CloneVT() *Any
  • func (this *Any) EqualMessageVT(thatMsg any) bool
  • func (this *Any) EqualVT(that *Any) bool
  • func (x *Any) GetTypeUrl() string
  • func (x *Any) GetValue() []byte
  • func (x *Any) MarshalFrom(m protobuf_go_lite.Message, typeURL string) error
  • func (x *Any) MarshalJSON() ([]byte, error)
  • func (x *Any) MarshalProtoJSON(s *json.MarshalState)
  • func (x *Any) MarshalProtoText() string
  • func (m *Any) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Any) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)
  • func (m *Any) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Any) MarshalToVTStrict(dAtA []byte) (int, error)
  • func (m *Any) MarshalVT() (dAtA []byte, err error)
  • func (m *Any) MarshalVTStrict() (dAtA []byte, err error)
  • func (x *Any) MessageIs(typeURL string) bool
  • func (*Any) ProtoMessage()
  • func (x *Any) Reset()
  • func (m *Any) SizeVT() (n int)
  • func (x *Any) String() string
  • func (x *Any) UnmarshalJSON(b []byte) error
  • func (x *Any) UnmarshalNew(typeURL string, resolver MessageTypeResolver) (protobuf_go_lite.Message, error)
  • func (x *Any) UnmarshalProtoJSON(s *json.UnmarshalState)
  • func (x *Any) UnmarshalTo(m protobuf_go_lite.Message, typeURL string) error
  • func (m *Any) UnmarshalVT(dAtA []byte) error
  • func (m *Any) UnmarshalVTUnsafe(dAtA []byte) error
• type MessageTypeResolver

Variables

var ErrNotFound = errors.New("message type not found in Any")

ErrNotFound is returned if the message type was not found.

Functions

func MarshalFrom

func MarshalFrom(dst *Any, src protobuf_go_lite.Message, typeURL string) error

MarshalFrom marshals src into dst as the underlying message using the provided marshal options.

If no options are specified, call dst.MarshalFrom instead.

func UnmarshalNew

func UnmarshalNew(src *Any, typeURL string, resolver MessageTypeResolver) (dst protobuf_go_lite.Message, err error)

UnmarshalNew unmarshals the underlying message from src into dst, which is newly created message using a type resolved from the type URL. The message type is resolved according to opt.Resolver, which should implement protoregistry.MessageTypeResolver. It reports an error if the underlying message type could not be resolved.

If no options are specified, call src.UnmarshalNew instead.

func UnmarshalTo

func UnmarshalTo(src *Any, dst protobuf_go_lite.Message, typeURL string) error

UnmarshalTo unmarshals the underlying message from src into dst using the provided unmarshal options. It reports an error if dst is not of the right message type.

If no options are specified, call src.UnmarshalTo instead.

Types

type Any

type Any struct {

	// 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. As of May 2023, there are no widely used type server
	// implementations and no plans to implement one.
	//
	// Schemes other than `http`, `https` (or the empty scheme) might be
	// used with implementation specific semantics.
	TypeUrl string `protobuf:"bytes,1,opt,name=type_url,json=typeUrl,proto3" json:"typeUrl,omitempty"`
	// Must be a valid serialized protocol buffer of the above specified type.
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

`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"
}

func New

func New(src protobuf_go_lite.Message, typeURL string) (*Any, error)

New marshals src into a new Any instance.

func (*Any) CloneMessageVT

func (m *Any) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Any) CloneVT

func (m *Any) CloneVT() *Any

func (*Any) EqualMessageVT

func (this *Any) EqualMessageVT(thatMsg any) bool

func (*Any) EqualVT

func (this *Any) EqualVT(that *Any) bool

func (*Any) GetTypeUrl

func (x *Any) GetTypeUrl() string

func (*Any) GetValue

func (x *Any) GetValue() []byte

func (*Any) MarshalFrom

func (x *Any) MarshalFrom(m protobuf_go_lite.Message, typeURL string) error

MarshalFrom marshals m into x as the underlying message.

func (*Any) MarshalJSON

func (x *Any) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Any to JSON.

func (*Any) MarshalProtoJSON

func (x *Any) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals an Any WKT.

func (*Any) MarshalProtoText

func (x *Any) MarshalProtoText() string

func (*Any) MarshalToSizedBufferVT

func (m *Any) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Any) MarshalToSizedBufferVTStrict

func (m *Any) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)

func (*Any) MarshalToVT

func (m *Any) MarshalToVT(dAtA []byte) (int, error)

func (*Any) MarshalToVTStrict

func (m *Any) MarshalToVTStrict(dAtA []byte) (int, error)

func (*Any) MarshalVT

func (m *Any) MarshalVT() (dAtA []byte, err error)

func (*Any) MarshalVTStrict

func (m *Any) MarshalVTStrict() (dAtA []byte, err error)

func (*Any) MessageIs

func (x *Any) MessageIs(typeURL string) bool

MessageIs reports whether the underlying message is of the same type as m.

func (*Any) ProtoMessage

func (*Any) ProtoMessage()

func (*Any) Reset

func (x *Any) Reset()

func (*Any) SizeVT

func (m *Any) SizeVT() (n int)

func (*Any) String

func (x *Any) String() string

func (*Any) UnmarshalJSON

func (x *Any) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Any from JSON.

func (*Any) UnmarshalNew

func (x *Any) UnmarshalNew(typeURL string, resolver MessageTypeResolver) (protobuf_go_lite.Message, error)

UnmarshalNew unmarshals the contents of the underlying message of x into a newly allocated message of the specified type. It reports an error if the underlying message type could not be resolved.

func (*Any) UnmarshalProtoJSON

func (x *Any) UnmarshalProtoJSON(s *json.UnmarshalState)

MarshalProtoJSON marshals an Any WKT. UnmarshalProtoJSON unmarshals an Any WKT.

func (*Any) UnmarshalTo

func (x *Any) UnmarshalTo(m protobuf_go_lite.Message, typeURL string) error

UnmarshalTo unmarshals the contents of the underlying message of x into m. It resets m before performing the unmarshal operation. It reports an error if m is not of the right message type.

func (*Any) UnmarshalVT

func (m *Any) UnmarshalVT(dAtA []byte) error

func (*Any) UnmarshalVTUnsafe

func (m *Any) UnmarshalVTUnsafe(dAtA []byte) error

type MessageTypeResolver

type MessageTypeResolver = anypb_resolver.AnyTypeResolver

MessageTypeResolver is an interface for looking up messages.

A compliant implementation must deterministically return the same type if no error is encountered.

The [Types] type implements this interface.