@Generated(value="proto") public static final class Struct.Builder extends 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
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)
TODO(jieluo): Clear it when all subclasses have implemented this method.
|
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.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.
|
protected MapField |
internalGetMapField(int number)
Gets the map field with the given field number.
|
protected MapField |
internalGetMutableMapField(int number)
Like
GeneratedMessageV3.Builder.internalGetMapField(int) but return a mutable version. |
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(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(UnknownFieldSet unknownFields)
Set the
UnknownFieldSet for this message. |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
mergeFrom
public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
GeneratedMessageV3.Builder
internalGetMapField
in class GeneratedMessageV3.Builder<Struct.Builder>
protected MapField internalGetMutableMapField(int number)
GeneratedMessageV3.Builder
GeneratedMessageV3.Builder.internalGetMapField(int)
but return a mutable version.internalGetMutableMapField
in class GeneratedMessageV3.Builder<Struct.Builder>
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
GeneratedMessageV3.Builder
internalGetFieldAccessorTable
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder clear()
GeneratedMessageV3.Builder
clear
in interface Message.Builder
clear
in interface MessageLite.Builder
clear
in class GeneratedMessageV3.Builder<Struct.Builder>
public Descriptors.Descriptor getDescriptorForType()
Message.Builder
MessageOrBuilder.getDescriptorForType()
.getDescriptorForType
in interface Message.Builder
getDescriptorForType
in interface MessageOrBuilder
getDescriptorForType
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct getDefaultInstanceForType()
MessageLiteOrBuilder
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.getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
public Struct build()
MessageLite.Builder
build
in interface Message.Builder
build
in interface MessageLite.Builder
public Struct buildPartial()
MessageLite.Builder
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.buildPartial
in interface Message.Builder
buildPartial
in interface MessageLite.Builder
public Struct.Builder clone()
MessageLite.Builder
clone
in interface Message.Builder
clone
in interface MessageLite.Builder
clone
in class GeneratedMessageV3.Builder<Struct.Builder>
Object.clone()
public Struct.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Message.Builder
MessageOrBuilder.getField(Descriptors.FieldDescriptor)
would return.setField
in interface Message.Builder
setField
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder clearField(Descriptors.FieldDescriptor field)
Message.Builder
clearField
in interface Message.Builder
clearField
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder clearOneof(Descriptors.OneofDescriptor oneof)
AbstractMessage.Builder
clearOneof
in interface Message.Builder
clearOneof
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Message.Builder
MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
would return.setRepeatedField
in interface Message.Builder
setRepeatedField
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
Message.Builder
setRepeatedField
, but appends the value as a new element.addRepeatedField
in interface Message.Builder
addRepeatedField
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder mergeFrom(Message other)
Message.Builder
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++.
mergeFrom
in interface Message.Builder
mergeFrom
in class AbstractMessage.Builder<Struct.Builder>
public Struct.Builder mergeFrom(Struct other)
public final boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3.Builder<Struct.Builder>
public Struct.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
MessageLite.Builder
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.mergeFrom
in interface Message.Builder
mergeFrom
in interface MessageLite.Builder
mergeFrom
in class AbstractMessage.Builder<Struct.Builder>
java.io.IOException
public int getFieldsCount()
StructOrBuilder
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
getFieldsCount
in interface StructOrBuilder
public boolean containsFields(java.lang.String key)
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
containsFields
in interface StructOrBuilder
@Deprecated public java.util.Map<java.lang.String,Value> getFields()
getFieldsMap()
instead.getFields
in interface StructOrBuilder
public java.util.Map<java.lang.String,Value> getFieldsMap()
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
getFieldsMap
in interface StructOrBuilder
public Value getFieldsOrDefault(java.lang.String key, Value defaultValue)
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
getFieldsOrDefault
in interface StructOrBuilder
public Value getFieldsOrThrow(java.lang.String key)
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
getFieldsOrThrow
in interface StructOrBuilder
public Struct.Builder clearFields()
public Struct.Builder removeFields(java.lang.String key)
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
@Deprecated public java.util.Map<java.lang.String,Value> getMutableFields()
public Struct.Builder putFields(java.lang.String key, Value value)
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
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;
public final Struct.Builder setUnknownFields(UnknownFieldSet unknownFields)
Message.Builder
UnknownFieldSet
for this message.setUnknownFields
in interface Message.Builder
setUnknownFields
in class GeneratedMessageV3.Builder<Struct.Builder>
public final Struct.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Message.Builder
UnknownFieldSet
for this message.mergeUnknownFields
in interface Message.Builder
mergeUnknownFields
in class GeneratedMessageV3.Builder<Struct.Builder>
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.