Struct.Builder

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
    - - com.google.protobuf.Struct.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, 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 and Description
`Struct.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)` Like `setRepeatedField`, but appends the value as a new element.
`Struct`	`build()` Constructs the message based on the state of the Builder.
`Struct`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Struct.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`Struct.Builder`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`Struct.Builder`	`clearFields()`
`Struct.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`Struct.Builder`	`clone()` Clones the Builder.
`boolean`	`containsFields(java.lang.String key)` Unordered map of dynamically typed values.
`Struct`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`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.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Struct.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Struct.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Struct.Builder`	`mergeFrom(Struct other)`
`Struct.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`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(Descriptors.FieldDescriptor field, java.lang.Object value)` Sets a field to the given value.
`Struct.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)` Sets an element of a repeated field to the given value.
`Struct.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

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

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - clear
```
public Struct.Builder clear()
```
    Description copied from class: com.google.protobuf.GeneratedMessageV3.Builder
    
    Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
    
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Description copied from interface: Message.Builder
    
    Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
    
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - getDefaultInstanceForType
```
public Struct 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
  - build
```
public Struct build()
```
    Description copied from interface: MessageLite.Builder
    
    Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public Struct buildPartial()
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - clone
```
public Struct.Builder clone()
```
    Description copied from interface: MessageLite.Builder
    
    Clones the Builder.
    
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
    
    See Also:
    
    Object.clone()
  - setField
```
public Struct.Builder setField(Descriptors.FieldDescriptor field,
                               java.lang.Object value)
```
    Description copied from interface: Message.Builder
    
    Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.
    
    Specified by:
    
    setField in interface Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - clearField
```
public Struct.Builder clearField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: Message.Builder
    
    Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.
    
    Specified by:
    
    clearField in interface Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - clearOneof
```
public Struct.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
    Description copied from class: AbstractMessage.Builder
    
    Specified by:
    
    clearOneof in interface Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - setRepeatedField
```
public Struct.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                       int index,
                                       java.lang.Object value)
```
    Description copied from interface: Message.Builder
    
    Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.
    
    Specified by:
    
    setRepeatedField in interface Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - addRepeatedField
```
public Struct.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                       java.lang.Object value)
```
    Description copied from interface: Message.Builder
    
    Like setRepeatedField, but appends the value as a new element.
    
    Specified by:
    
    addRepeatedField in interface Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - mergeFrom
```
public Struct.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<Struct.Builder>
  - mergeFrom
```
public Struct.Builder mergeFrom(Struct other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - mergeFrom
```
public Struct.Builder mergeFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class 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
  - getFields
```
@Deprecated
public java.util.Map<java.lang.String,Value> getFields()
```
    Deprecated.
    
    Use getFieldsMap() instead.
    
    Specified by:
    
    getFields 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
  - clearFields
```
public Struct.Builder clearFields()
```
  - 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)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>
  - mergeUnknownFields
```
public final Struct.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Struct.Builder>

Class Struct.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getFieldsCount

containsFields

getFields

getFieldsMap

getFieldsOrDefault

getFieldsOrThrow

clearFields

removeFields

getMutableFields

putFields

putAllFields

setUnknownFields

mergeUnknownFields