Package com.google.protobuf

Class Struct.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StructOrBuilder, java.lang.Cloneable
    Enclosing class:
    Struct
    public static final class Struct.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
implements StructOrBuilder
     `Struct` represents a structured data value, consisting of fields
 which map to dynamically typed values. In some languages, `Struct`
 might be supported by a native representation. For example, in
 scripting languages like JS a struct is represented as an
 object. The details of that representation are described together
 with the proto support for the language.

 The JSON representation for `Struct` is JSON object.
    Protobuf type google.protobuf.Struct

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Struct.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Struct build()  
      Struct buildPartial()  
      Struct.Builder clear()  
      Struct.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Struct.Builder clearFields()  
      Struct.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Struct.Builder clone()  
      boolean containsFields​(java.lang.String key)
      Unordered map of dynamically typed values.
      Struct getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.util.Map<java.lang.String,​Value> getFields()
      Deprecated.
      int getFieldsCount()
      Unordered map of dynamically typed values.
      java.util.Map<java.lang.String,​Value> getFieldsMap()
      Unordered map of dynamically typed values.
      Value getFieldsOrDefault​(java.lang.String key, Value defaultValue)
      Unordered map of dynamically typed values.
      Value getFieldsOrThrow​(java.lang.String key)
      Unordered map of dynamically typed values.
      java.util.Map<java.lang.String,​Value> getMutableFields()
      Deprecated.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      protected com.google.protobuf.MapField internalGetMutableMapField​(int number)  
      boolean isInitialized()  
      Struct.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Struct.Builder mergeFrom​(com.google.protobuf.Message other)  
      Struct.Builder mergeFrom​(Struct other)  
      Struct.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Struct.Builder putAllFields​(java.util.Map<java.lang.String,​Value> values)
      Unordered map of dynamically typed values.
      Struct.Builder putFields​(java.lang.String key, Value value)
      Unordered map of dynamically typed values.
      Struct.Builder removeFields​(java.lang.String key)
      Unordered map of dynamically typed values.
      Struct.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Struct.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      Struct.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>

      • internalGetFieldAccessorTable

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

      • clear

        public Struct.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<Struct.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<Struct.Builder>

      • getDefaultInstanceForType

        public Struct getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public Struct.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<Struct.Builder>

      • setField

        public Struct.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<Struct.Builder>

      • clearField

        public Struct.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<Struct.Builder>

      • clearOneof

        public Struct.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<Struct.Builder>

      • setRepeatedField

        public Struct.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<Struct.Builder>

      • addRepeatedField

        public Struct.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<Struct.Builder>

      • mergeFrom

        public Struct.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<Struct.Builder>

      • isInitialized

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

      • mergeFrom

        public Struct.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<Struct.Builder>
        Throws:
        java.io.IOException

      • getFieldsCount

        public int getFieldsCount()
        Description copied from interface: StructOrBuilder
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;
        Specified by:
        getFieldsCount in interface StructOrBuilder

      • containsFields

        public boolean containsFields​(java.lang.String key)
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;
        Specified by:
        containsFields in interface StructOrBuilder

      • getFieldsMap

        public java.util.Map<java.lang.String,​Value> getFieldsMap()
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;
        Specified by:
        getFieldsMap in interface StructOrBuilder

      • getFieldsOrDefault

        public Value getFieldsOrDefault​(java.lang.String key,
                                Value defaultValue)
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;
        Specified by:
        getFieldsOrDefault in interface StructOrBuilder

      • getFieldsOrThrow

        public Value getFieldsOrThrow​(java.lang.String key)
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;
        Specified by:
        getFieldsOrThrow in interface StructOrBuilder

      • removeFields

        public Struct.Builder removeFields​(java.lang.String key)
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;

      • getMutableFields

        @Deprecated
public java.util.Map<java.lang.String,​Value> getMutableFields()
        Deprecated.
        Use alternate mutation accessors instead.

      • putFields

        public Struct.Builder putFields​(java.lang.String key,
                                Value value)
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;

      • putAllFields

        public Struct.Builder putAllFields​(java.util.Map<java.lang.String,​Value> values)
         Unordered map of dynamically typed values.
        map<string, .google.protobuf.Value> fields = 1;

      • setUnknownFields

        public final Struct.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<Struct.Builder>

      • mergeUnknownFields

        public final Struct.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<Struct.Builder>