Package com.google.protobuf

Class Any.Builder

  • All Implemented Interfaces:
    AnyOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    Any
    public static final class Any.Builder
extends GeneratedMessage.Builder<Any.Builder>
implements AnyOrBuilder
     `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"
 }
    Protobuf type google.protobuf.Any

    • Field Detail

      • bitField0_

        private int bitField0_

      • typeUrl_

        private java.lang.Object typeUrl_

    • Method Detail

      • getDefaultInstanceForType

        public Any getDefaultInstanceForType()
        Description copied from interface: MessageLiteOrBuilder
        Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
        Specified by:
        getDefaultInstanceForType in interface MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface MessageOrBuilder

      • buildPartial0

        private void buildPartial0​(Any result)

      • mergeFrom

        public Any.Builder mergeFrom​(Message other)
        Description copied from interface: Message.Builder
        Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

        Merging occurs as follows. For each field:
        * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
        * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
        * For repeated fields, the elements in other are concatenated with the elements in this message.
        * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

        This is equivalent to the Message::MergeFrom method in C++.

        Specified by:
        mergeFrom in interface Message.Builder
        Overrides:
        mergeFrom in class AbstractMessage.Builder<Any.Builder>

      • getTypeUrl

        public java.lang.String getTypeUrl()
         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.
        string type_url = 1;
        Specified by:
        getTypeUrl in interface AnyOrBuilder
        Returns:
        The typeUrl.

      • getTypeUrlBytes

        public ByteString getTypeUrlBytes()
         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.
        string type_url = 1;
        Specified by:
        getTypeUrlBytes in interface AnyOrBuilder
        Returns:
        The bytes for typeUrl.

      • setTypeUrl

        public Any.Builder setTypeUrl​(java.lang.String value)
         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.
        string type_url = 1;
        Parameters:
        value - The typeUrl to set.
        Returns:
        This builder for chaining.

      • clearTypeUrl

        public Any.Builder clearTypeUrl()
         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.
        string type_url = 1;
        Returns:
        This builder for chaining.

      • setTypeUrlBytes

        public Any.Builder setTypeUrlBytes​(ByteString value)
         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.
        string type_url = 1;
        Parameters:
        value - The bytes for typeUrl to set.
        Returns:
        This builder for chaining.

      • getValue

        public ByteString getValue()
         Must be a valid serialized protocol buffer of the above specified type.
        bytes value = 2;
        Specified by:
        getValue in interface AnyOrBuilder
        Returns:
        The value.

      • setValue

        public Any.Builder setValue​(ByteString value)
         Must be a valid serialized protocol buffer of the above specified type.
        bytes value = 2;
        Parameters:
        value - The value to set.
        Returns:
        This builder for chaining.

      • clearValue

        public Any.Builder clearValue()
         Must be a valid serialized protocol buffer of the above specified type.
        bytes value = 2;
        Returns:
        This builder for chaining.