@Generated(value="proto") public final class Struct extends GeneratedMessageV3 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 | Class and Description |
---|---|
static class |
Struct.Builder
`Struct` represents a structured data value, consisting of fields
which map to dynamically typed values.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
FIELDS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
containsFields(java.lang.String key)
Unordered map of dynamically typed values.
|
boolean |
equals(java.lang.Object obj)
Compares the specified object with this message for equality.
|
static Struct |
getDefaultInstance() |
Struct |
getDefaultInstanceForType()
Get an instance of the type with no fields set.
|
static Descriptors.Descriptor |
getDescriptor() |
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.
|
Parser<Struct> |
getParserForType()
Gets the parser for a message of the same type as this message.
|
int |
getSerializedSize()
Get the number of bytes required to encode this message.
|
UnknownFieldSet |
getUnknownFields()
Get the
UnknownFieldSet for this message. |
int |
hashCode()
Returns the hash code value for this message.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.
|
protected MapField |
internalGetMapField(int number)
Gets the map field with the given field number.
|
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false
otherwise.
|
static Struct.Builder |
newBuilder() |
static Struct.Builder |
newBuilder(Struct prototype) |
Struct.Builder |
newBuilderForType()
Constructs a new builder for a message of the same type as this message.
|
protected Struct.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
|
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(java.nio.ByteBuffer data) |
static Struct |
parseFrom(java.nio.ByteBuffer 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 Parser<Struct> |
parser() |
Struct.Builder |
toBuilder()
Constructs a builder initialized with the current message.
|
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int FIELDS_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
MessageOrBuilder
UnknownFieldSet
for this message.getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
GeneratedMessageV3
internalGetMapField
in class GeneratedMessageV3
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
GeneratedMessageV3
internalGetFieldAccessorTable
in class GeneratedMessageV3
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 final boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws java.io.IOException
MessageLite
output
. This does not flush or close the
stream.writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(java.lang.Object obj)
Message
true
if the given
object is a message of the same type (as defined by getDescriptorForType()
) and has
identical values for all of its fields. Subclasses must implement this; inheriting Object.equals()
is incorrect.equals
in interface Message
equals
in class AbstractMessage
obj
- object to be compared for equality with this messagetrue
if the specified object is equal to this messagepublic int hashCode()
Message
Object.hashCode()
is incorrect.hashCode
in interface Message
hashCode
in class AbstractMessage
Map.hashCode()
public static Struct parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Struct parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Struct parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Struct parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Struct parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Struct parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Struct parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Struct parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Struct parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Struct parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Struct parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Struct parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Struct.Builder newBuilderForType()
MessageLite
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static Struct.Builder newBuilder()
public static Struct.Builder newBuilder(Struct prototype)
public Struct.Builder toBuilder()
MessageLite
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected Struct.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
GeneratedMessageV3
newBuilderForType
in class GeneratedMessageV3
public static Struct getDefaultInstance()
public Parser<Struct> getParserForType()
MessageLite
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
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
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.