Class Struct

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.Struct

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, StructOrBuilder, Serializable

@Generated
public final class Struct
extends GeneratedMessage
implements StructOrBuilder

Represents a JSON object.

An unordered key-value map, intending to perfectly capture the semantics of a
JSON object. This enables parsing any arbitrary JSON payload as a message
field in ProtoJSON format.

This follows RFC 8259 guidelines for interoperable JSON: notably this type
cannot represent large Int64 values or `NaN`/`Infinity` numbers,
since the JSON format generally does not support those values in its number
type.

If you do not intend to parse arbitrary JSON into your message, a custom
typed message should be preferred instead of using this type.

Protobuf type google.protobuf.Struct

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Struct.Builder	Represents a JSON object.
private static final class	Struct.FieldsDefaultEntryHolder

Nested classes/interfaces inherited from class GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, GeneratedMessage.ExtendableMessage<MessageT>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, GeneratedMessage.ExtensionDescriptorRetriever, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT, T>, GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessage

AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private static final Struct	DEFAULT_INSTANCE
private MapField<String,Value>	fields_
static final int	FIELDS_FIELD_NUMBER
private byte	memoizedIsInitialized
private static final Parser<Struct>	PARSER
private static final long	serialVersionUID

Fields inherited from class GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, PRE22_GENCODE_ERROR_PROPERTY, PRE22_GENCODE_SILENCE_PROPERTY, PRE22_GENCODE_VULNERABILITY_MESSAGE, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Struct()
private	Struct(GeneratedMessage.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
private int	computeSerializedSize_0()
boolean	containsFields(String key)	Unordered map of dynamically typed values.
boolean	equals(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 final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
Map<String,Value>	getFields()	Deprecated.
int	getFieldsCount()	Unordered map of dynamically typed values.
Map<String,Value>	getFieldsMap()	Unordered map of dynamically typed values.
Value	getFieldsOrDefault(String key, Value defaultValue)	Unordered map of dynamically typed values.
Value	getFieldsOrThrow(String key)	Unordered map of dynamically typed values.
Parser<Struct>	getParserForType()	TODO: Remove this unnecessary intermediate implementation of this method.
int	getSerializedSize()	Get the number of bytes required to encode this message.
int	hashCode()	Returns the hash code value for this message.
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
private MapField<String,Value>	internalGetFields()
protected MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)	Gets the map field with the given field number.
final 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(AbstractMessage.BuilderParent parent)	Create a nested builder.
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)
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.

Methods inherited from class GeneratedMessage

computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, setUnknownFields, warnPre22Gencode, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashFields, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

• Constant Field Values

fields_

private MapField<String,Value> fields_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Struct DEFAULT_INSTANCE

PARSER

private static final Parser<Struct> PARSER

Constructor Details

Struct

private Struct(GeneratedMessage.Builder<?> builder)

Struct

private Struct()

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: MessageOrBuilder

Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage

internalGetMapFieldReflection

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Description copied from class: GeneratedMessage

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 class GeneratedMessage

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessage

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 class GeneratedMessage

internalGetFields

private MapField<String,Value> internalGetFields()

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 interface StructOrBuilder

containsFields

public boolean containsFields(String key)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

containsFields in interface StructOrBuilder

getFields

@Deprecated
public Map<String,Value> getFields()

Deprecated.

Use getFieldsMap() instead.

Specified by:

getFields in interface StructOrBuilder

getFieldsMap

public Map<String,Value> getFieldsMap()

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsMap in interface StructOrBuilder

getFieldsOrDefault

public Value getFieldsOrDefault(String key,
 Value defaultValue)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsOrDefault in interface StructOrBuilder

getFieldsOrThrow

public Value getFieldsOrThrow(String key)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsOrThrow in interface StructOrBuilder

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.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

IOException

computeSerializedSize_0

private int computeSerializedSize_0()

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

equals

public boolean equals(Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns 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.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

Parameters:

obj - object to be compared for equality with this message

Returns:

true if the specified object is equal to this message

hashCode

public int hashCode()

Description copied from interface: Message

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

parseFrom

public static Struct parseFrom(ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Struct parseFrom(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(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Struct parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Struct parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Struct parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Struct parseFrom(CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Struct parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Struct.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Struct.Builder newBuilder()

newBuilder

public static Struct.Builder newBuilder(Struct prototype)

toBuilder

public Struct.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Struct.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Description copied from class: AbstractMessage

Create a nested builder.

Overrides:

newBuilderForType in class AbstractMessage

getDefaultInstance

public static Struct getDefaultInstance()

parser

public static Parser<Struct> parser()

getParserForType

public Parser<Struct> getParserForType()

Description copied from class: GeneratedMessage

TODO: Remove this unnecessary intermediate implementation of this method.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

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 the 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.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder