Class Any.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, AnyOrBuilder
    Enclosing class:
    Any

    public static final class Any.Builder
    extends com.google.protobuf.GeneratedMessageV3.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);
         }
      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 := ptypes.MarshalAny(foo)
          ...
          foo := &pb.Foo{}
          if err := ptypes.UnmarshalAny(any, 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 org.platanios.tensorflow.proto.google.Any
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Any.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Any build()  
      Any buildPartial()  
      Any.Builder clear()  
      Any.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Any.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Any.Builder clearTypeUrl()
      A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
      Any.Builder clearValue()
      Must be a valid serialized protocol buffer of the above specified type.
      Any.Builder clone()  
      Any getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.lang.String getTypeUrl()
      A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
      com.google.protobuf.ByteString getTypeUrlBytes()
      A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
      com.google.protobuf.ByteString getValue()
      Must be a valid serialized protocol buffer of the above specified type.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Any.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Any.Builder mergeFrom​(com.google.protobuf.Message other)  
      Any.Builder mergeFrom​(Any other)  
      Any.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Any.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Any.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      Any.Builder setTypeUrl​(java.lang.String value)
      A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
      Any.Builder setTypeUrlBytes​(com.google.protobuf.ByteString value)
      A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
      Any.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Any.Builder setValue​(com.google.protobuf.ByteString value)
      Must be a valid serialized protocol buffer of the above specified type.
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeFrom, newUninitializedMessageException
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • clear

        public Any.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • getDefaultInstanceForType

        public Any getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public Any build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public Any buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public Any.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • setField

        public Any.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • clearField

        public Any.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • clearOneof

        public Any.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • setRepeatedField

        public Any.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • addRepeatedField

        public Any.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • mergeFrom

        public Any.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Any.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • mergeFrom

        public Any.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Any.Builder>
        Throws:
        java.io.IOException
      • 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.
         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 com.google.protobuf.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.
         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.
         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.
         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​(com.google.protobuf.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.
         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 com.google.protobuf.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​(com.google.protobuf.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.
      • setUnknownFields

        public final Any.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>
      • mergeUnknownFields

        public final Any.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Any.Builder>