com.google.protobuf

Class Struct

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.Struct

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StructOrBuilder, java.io.Serializable

public final class Struct
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

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 and Description
boolean	containsFields(java.lang.String key) Unordered map of dynamically typed values.
boolean	equals(java.lang.Object obj)
static Struct	getDefaultInstance()
Struct	getDefaultInstanceForType()
static com.google.protobuf.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.
com.google.protobuf.Parser<Struct>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Struct.Builder	newBuilder()
static Struct.Builder	newBuilder(Struct prototype)
Struct.Builder	newBuilderForType()
protected Struct.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
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(java.nio.ByteBuffer data)
static Struct	parseFrom(java.nio.ByteBuffer 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 com.google.protobuf.Parser<Struct>	parser()
Struct.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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(java.lang.String key)

 Unordered map of dynamically typed values.
 

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

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()

 Unordered map of dynamically typed values.
 

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

Specified by:

getFieldsMap in interface StructOrBuilder

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

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

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Struct.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Struct getDefaultInstance()

parser

public static com.google.protobuf.Parser<Struct> parser()

getParserForType

public com.google.protobuf.Parser<Struct> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Struct getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder