Documentation ¶
Index ¶
- Variables
- func MarshalFrom(dst *Any, src proto.Message, opts proto.MarshalOptions) error
- func UnmarshalNew(src *Any, opts proto.UnmarshalOptions) (dst proto.Message, err error)
- func UnmarshalTo(src *Any, dst proto.Message, opts proto.UnmarshalOptions) error
- type Any
- func (*Any) Descriptor() ([]byte, []int)deprecated
- func (x *Any) GetTypeUrl() string
- func (x *Any) GetValue() []byte
- func (x *Any) MarshalFrom(m proto.Message) error
- func (x *Any) MessageIs(m proto.Message) bool
- func (x *Any) MessageName() protoreflect.FullName
- func (*Any) ProtoMessage()
- func (x *Any) ProtoReflect() protoreflect.Message
- func (x *Any) Reset()
- func (x *Any) String() string
- func (x *Any) UnmarshalNew() (proto.Message, error)
- func (x *Any) UnmarshalTo(m proto.Message) error
- func (m *Any) Validate() error
- func (m *Any) ValidateAll() error
- type AnyMultiError
- type AnyValidationError
Constants ¶
This section is empty.
Variables ¶
var File_any_proto protoreflect.FileDescriptor
Functions ¶
func MarshalFrom ¶
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 ¶
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 ¶
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. // // 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:"type_url,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); }
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 (*Any) Descriptor
deprecated
func (*Any) GetTypeUrl ¶
func (*Any) MarshalFrom ¶
MarshalFrom marshals m into x as the underlying message.
func (*Any) MessageName ¶
func (x *Any) MessageName() protoreflect.FullName
MessageName reports the full name of the underlying message, returning an empty string if invalid.
func (*Any) ProtoMessage ¶
func (*Any) ProtoMessage()
func (*Any) ProtoReflect ¶
func (x *Any) ProtoReflect() protoreflect.Message
func (*Any) UnmarshalNew ¶
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) UnmarshalTo ¶
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) Validate ¶
Validate checks the field values on Any with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Any) ValidateAll ¶
ValidateAll checks the field values on Any with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AnyMultiError, or nil if none found.
type AnyMultiError ¶
type AnyMultiError []error
AnyMultiError is an error wrapping multiple validation errors returned by Any.ValidateAll() if the designated constraints aren't met.
func (AnyMultiError) AllErrors ¶
func (m AnyMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (AnyMultiError) Error ¶
func (m AnyMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type AnyValidationError ¶
type AnyValidationError struct {
// contains filtered or unexported fields
}
AnyValidationError is the validation error returned by Any.Validate if the designated constraints aren't met.
func (AnyValidationError) Cause ¶
func (e AnyValidationError) Cause() error
Cause function returns cause value.
func (AnyValidationError) Error ¶
func (e AnyValidationError) Error() string
Error satisfies the builtin error interface
func (AnyValidationError) ErrorName ¶
func (e AnyValidationError) ErrorName() string
ErrorName returns error name.
func (AnyValidationError) Field ¶
func (e AnyValidationError) Field() string
Field function returns field value.
func (AnyValidationError) Key ¶
func (e AnyValidationError) Key() bool
Key function returns key value.
func (AnyValidationError) Reason ¶
func (e AnyValidationError) Reason() string
Reason function returns reason value.