Package com.google.protobuf
Class Struct
- All Implemented Interfaces:
MessageLite
,MessageLiteOrBuilder
,StructOrBuilder
public final class Struct
extends GeneratedMessageLite<Struct,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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
`Struct` represents a structured data value, consisting of fields which map to dynamically typed values.private static final class
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,
?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageLite.ExtensionDescriptor, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite, Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Struct
private MapFieldLite
<String, Value> static final int
Fields inherited from class com.google.protobuf.GeneratedMessageLite
UNINITIALIZED_HASH_CODE, UNINITIALIZED_SERIALIZED_SIZE, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsFields
(String key) Unordered map of dynamically typed values.protected final Object
dynamicMethod
(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
.static Struct
Deprecated.int
Unordered map of dynamically typed values.Unordered map of dynamically typed values.getFieldsOrDefault
(String key, Value defaultValue) Unordered map of dynamically typed values.getFieldsOrThrow
(String key) Unordered map of dynamically typed values.Unordered map of dynamically typed values.private MapFieldLite
<String, Value> private MapFieldLite
<String, Value> static Struct.Builder
static Struct.Builder
newBuilder
(Struct prototype) static Struct
parseDelimitedFrom
(InputStream input) static Struct
parseDelimitedFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Struct
parseFrom
(byte[] data) static Struct
parseFrom
(byte[] data, ExtensionRegistryLite extensionRegistry) static Struct
parseFrom
(ByteString data) static Struct
parseFrom
(ByteString data, ExtensionRegistryLite extensionRegistry) static Struct
parseFrom
(CodedInputStream input) static Struct
parseFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) static Struct
parseFrom
(InputStream input) static Struct
parseFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Struct
parseFrom
(ByteBuffer data) static Struct
parseFrom
(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()
Methods inherited from class com.google.protobuf.GeneratedMessageLite
buildMessageInfo, clearMemoizedHashCode, clearMemoizedSerializedSize, computeHashCode, createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstance, getDefaultInstanceForType, getMemoizedHashCode, getMemoizedSerializedSize, getMethodOrDie, getParserForType, getSerializedSize, getSerializedSize, hashCode, hashCodeIsNotMemoized, invokeOrDie, isInitialized, isInitialized, isMutable, makeImmutable, markImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newMutableInstance, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, setMemoizedHashCode, setMemoizedSerializedSize, toBuilder, toString, writeTo
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, newUninitializedMessageException, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER- See Also:
-
fields_
-
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Struct
private Struct()
-
-
Method Details
-
internalGetFields
-
internalGetMutableFields
-
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 interfaceStructOrBuilder
-
containsFields
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
- Specified by:
containsFields
in interfaceStructOrBuilder
-
getFields
Deprecated.UsegetFieldsMap()
instead.- Specified by:
getFields
in interfaceStructOrBuilder
-
getFieldsMap
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
- Specified by:
getFieldsMap
in interfaceStructOrBuilder
-
getFieldsOrDefault
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
- Specified by:
getFieldsOrDefault
in interfaceStructOrBuilder
-
getFieldsOrThrow
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
- Specified by:
getFieldsOrThrow
in interfaceStructOrBuilder
-
getMutableFieldsMap
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Struct parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Struct parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Struct parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) Description copied from class:GeneratedMessageLite
A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.NEW_INSTANCE
returns a new instance of the protocol buffer that has not yet been made immutable. SeeMAKE_IMMUTABLE
.IS_INITIALIZED
returnsnull
for false and the default instance for true. It doesn't use or modify any memoized value.GET_MEMOIZED_IS_INITIALIZED
returns the memoizedisInitialized
byte value.SET_MEMOIZED_IS_INITIALIZED
sets the memoizedisInitialized
byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.NEW_BUILDER
returns aBuilderType
instance.
For use by generated code only.
- Specified by:
dynamicMethod
in classGeneratedMessageLite<Struct,
Struct.Builder>
-
getDefaultInstance
-
parser
-