Package com.google.protobuf

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, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, MessageOrBuilder, StructOrBuilder, java.io.Serializable

public final class Struct
extends GeneratedMessage
implements StructOrBuilder

Protobuf type google.protobuf.Struct

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Struct.Builder	Protobuf type google.protobuf.Struct

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	FIELDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	containsFields(java.lang.String key)	map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];
boolean	equals(java.lang.Object obj)	Compares the specified object with this message for equality.
static Struct	getDefaultInstance()
Struct	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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"];
com.google.protobuf.Parser<Struct>	getParserForType()	TODO: Remove this unnecessary intermediate implementation of this method.
int	getSerializedSize()
int	hashCode()	Returns the hash code value for this message.
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
protected MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)	Gets the map field with the given field number.
boolean	isInitialized()
static Struct.Builder	newBuilder()
static Struct.Builder	newBuilder(Struct prototype)
Struct.Builder	newBuilderForType()
protected Struct.Builder	newBuilderForType(AbstractMessage.BuilderParent parent)	Create a nested builder.
static Struct	parseDelimitedFrom(java.io.InputStream input)
static Struct	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Struct	parseFrom(byte[] data)
static Struct	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Struct	parseFrom(com.google.protobuf.ByteString data)
static Struct	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Struct	parseFrom(com.google.protobuf.CodedInputStream input)
static Struct	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Struct	parseFrom(java.io.InputStream input)
static Struct	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Struct	parseFrom(java.nio.ByteBuffer data)
static Struct	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Struct>	parser()
Struct.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

getFieldsCount

public int getFieldsCount()

Description copied from interface: StructOrBuilder

map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];

Specified by:

getFieldsCount in interface StructOrBuilder

containsFields

public boolean containsFields(java.lang.String key)

map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];

Specified by:

containsFields in interface StructOrBuilder

getFields

@Deprecated
public java.util.Map<java.lang.String,Value> getFields()

Deprecated.

Use getFieldsMap() instead.

Specified by:

getFields in interface StructOrBuilder

getFieldsMap

public java.util.Map<java.lang.String,Value> getFieldsMap()

map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];

Specified by:

getFieldsMap in interface StructOrBuilder

getFieldsOrDefault

public Value getFieldsOrDefault(java.lang.String key,
                                Value defaultValue)

map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];

Specified by:

getFieldsOrDefault in interface StructOrBuilder

getFieldsOrThrow

public Value getFieldsOrThrow(java.lang.String key)

map<string, .google.protobuf.Value> fields = 1 [json_name = "fields"];

Specified by:

getFieldsOrThrow in interface StructOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

equals

public boolean equals(java.lang.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(java.nio.ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Struct parseFrom(java.nio.ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Struct parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Struct parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Struct parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Struct parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.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,
                               com.google.protobuf.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,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Struct parseFrom(com.google.protobuf.CodedInputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Struct parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Struct.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Struct.Builder newBuilder()

newBuilder

public static Struct.Builder newBuilder(Struct prototype)

toBuilder

public Struct.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface com.google.protobuf.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 com.google.protobuf.Parser<Struct> parser()

getParserForType

public com.google.protobuf.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 com.google.protobuf.MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public Struct getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder