Class Struct.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.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 GeneratedMessage.Builder<Struct.Builder> implements StructOrBuilder
Protobuf typegoogle.protobuf.Struct
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Struct
build()
Constructs the message based on the state of the Builder.Struct
buildPartial()
LikeMessageLite.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
clearFields()
boolean
containsFields(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
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()
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
java.util.Map<java.lang.String,Value>
getFieldsMap()
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
Value
getFieldsOrDefault(java.lang.String key, Value defaultValue)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
Value
getFieldsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
java.util.Map<java.lang.String,Value>
getMutableFields()
Deprecated.protected GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.protected MapFieldReflectionAccessor
internalGetMapFieldReflection(int number)
Gets the map field with the given field number.protected MapFieldReflectionAccessor
internalGetMutableMapFieldReflection(int number)
LikeGeneratedMessage.Builder.internalGetMapFieldReflection(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)
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Struct.Builder
mergeFrom(Message other)
Mergeother
into the message being built.Struct.Builder
mergeFrom(Struct other)
Struct.Builder
putAllFields(java.util.Map<java.lang.String,Value> values)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
Struct.Builder
putFields(java.lang.String key, Value value)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
Value.Builder
putFieldsBuilderIfAbsent(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
Struct.Builder
removeFields(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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 Descriptors.Descriptor getDescriptor()
-
internalGetMapFieldReflection
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Description copied from class:GeneratedMessage.Builder
Gets the map field with the given field number. This method should be overridden in the generated message class if the message contains map fields.Unlike other field types, reflection support for map fields can't be implemented based on generated public API because we need to access a map field as a list in reflection API but the generated API only allows us to access it as a map. This method returns the underlying map field directly and thus enables us to access the map field as a list.
- Overrides:
internalGetMapFieldReflection
in classGeneratedMessage.Builder<Struct.Builder>
-
internalGetMutableMapFieldReflection
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Description copied from class:GeneratedMessage.Builder
LikeGeneratedMessage.Builder.internalGetMapFieldReflection(int)
but return a mutable version.- Overrides:
internalGetMutableMapFieldReflection
in classGeneratedMessage.Builder<Struct.Builder>
-
internalGetFieldAccessorTable
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Description copied from class:GeneratedMessage.Builder
Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTable
in classGeneratedMessage.Builder<Struct.Builder>
-
clear
public Struct.Builder clear()
Description copied from class:GeneratedMessage.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 interfaceMessage.Builder
- Specified by:
clear
in interfaceMessageLite.Builder
- Overrides:
clear
in classGeneratedMessage.Builder<Struct.Builder>
-
getDescriptorForType
public Descriptors.Descriptor getDescriptorForType()
Description copied from interface:Message.Builder
Get the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType()
.- Specified by:
getDescriptorForType
in interfaceMessage.Builder
- Specified by:
getDescriptorForType
in interfaceMessageOrBuilder
- Overrides:
getDescriptorForType
in classGeneratedMessage.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 thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-
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 interfaceMessage.Builder
- Specified by:
build
in interfaceMessageLite.Builder
-
buildPartial
public Struct buildPartial()
Description copied from interface:MessageLite.Builder
LikeMessageLite.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 interfaceMessage.Builder
- Specified by:
buildPartial
in interfaceMessageLite.Builder
-
mergeFrom
public Struct.Builder mergeFrom(Message other)
Description copied from interface:Message.Builder
Mergeother
into the message being built.other
must have the exact same type asthis
(i.e.getDescriptorForType() == other.getDescriptorForType()
).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother
, thenother
's value overwrites the value in this message.
* For singular message fields, if the field is set inother
, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inother
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 interfaceMessage.Builder
- Overrides:
mergeFrom
in classAbstractMessage.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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessage.Builder<Struct.Builder>
-
mergeFrom
public Struct.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry
. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfaceMessageLite.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<Struct.Builder>
- Throws:
InvalidProtocolBufferException
- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.java.io.IOException
- an I/O error reading from the stream
-
getFieldsCount
public int getFieldsCount()
Description copied from interface:StructOrBuilder
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
- Specified by:
getFieldsCount
in interfaceStructOrBuilder
-
containsFields
public boolean containsFields(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
- Specified by:
containsFields
in interfaceStructOrBuilder
-
getFields
@Deprecated public java.util.Map<java.lang.String,Value> getFields()
Deprecated.UsegetFieldsMap()
instead.- Specified by:
getFields
in interfaceStructOrBuilder
-
getFieldsMap
public java.util.Map<java.lang.String,Value> getFieldsMap()
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
- Specified by:
getFieldsMap
in interfaceStructOrBuilder
-
getFieldsOrDefault
public Value getFieldsOrDefault(java.lang.String key, Value defaultValue)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
- Specified by:
getFieldsOrDefault
in interfaceStructOrBuilder
-
getFieldsOrThrow
public Value getFieldsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
- Specified by:
getFieldsOrThrow
in interfaceStructOrBuilder
-
clearFields
public Struct.Builder clearFields()
-
removeFields
public Struct.Builder removeFields(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
-
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)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
-
putAllFields
public Struct.Builder putAllFields(java.util.Map<java.lang.String,Value> values)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
-
putFieldsBuilderIfAbsent
public Value.Builder putFieldsBuilderIfAbsent(java.lang.String key)
map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
-
-