Package com.google.protobuf
Class Struct
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
-
- com.google.protobuf.GeneratedMessageLite<Struct,Struct.Builder>
-
- com.google.protobuf.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 typegoogle.protobuf.Struct
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Struct.Builder
`Struct` represents a structured data value, consisting of fields which map to dynamically typed values.private static class
Struct.FieldsDefaultEntryHolder
-
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
Fields Modifier and Type Field Description private static Struct
DEFAULT_INSTANCE
private MapFieldLite<java.lang.String,Value>
fields_
static int
FIELDS_FIELD_NUMBER
private static Parser<Struct>
PARSER
-
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 Modifier Constructor Description private
Struct()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsFields(java.lang.String key)
Unordered map of dynamically typed values.protected java.lang.Object
dynamicMethod(GeneratedMessageLite.MethodToInvoke method, java.lang.Object arg0, java.lang.Object arg1)
A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
.static Struct
getDefaultInstance()
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.private java.util.Map<java.lang.String,Value>
getMutableFieldsMap()
Unordered map of dynamically typed values.private MapFieldLite<java.lang.String,Value>
internalGetFields()
private MapFieldLite<java.lang.String,Value>
internalGetMutableFields()
static Struct.Builder
newBuilder()
static Struct.Builder
newBuilder(Struct prototype)
static Struct
parseDelimitedFrom(java.io.InputStream input)
static Struct
parseDelimitedFrom(java.io.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(java.io.InputStream input)
static Struct
parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Struct
parseFrom(java.nio.ByteBuffer data)
static Struct
parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<Struct>
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 Detail
-
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
fields_
private MapFieldLite<java.lang.String,Value> fields_
-
DEFAULT_INSTANCE
private static final Struct DEFAULT_INSTANCE
-
-
Method Detail
-
internalGetFields
private MapFieldLite<java.lang.String,Value> internalGetFields()
-
internalGetMutableFields
private MapFieldLite<java.lang.String,Value> 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
public boolean containsFields(java.lang.String key)
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
- 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()
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
- Specified by:
getFieldsMap
in interfaceStructOrBuilder
-
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 interfaceStructOrBuilder
-
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 interfaceStructOrBuilder
-
getMutableFieldsMap
private java.util.Map<java.lang.String,Value> getMutableFieldsMap()
Unordered map of dynamically typed values.
map<string, .google.protobuf.Value> fields = 1;
-
parseFrom
public static Struct parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(ByteString data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(byte[] data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Struct parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Struct parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Struct parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Struct parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Struct parseFrom(CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Struct parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilder
public static Struct.Builder newBuilder()
-
newBuilder
public static Struct.Builder newBuilder(Struct prototype)
-
dynamicMethod
protected final java.lang.Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, java.lang.Object arg0, java.lang.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
public static Struct getDefaultInstance()
-
-