Struct (Protocol Buffers [Core] 3.5.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.protobuf.Struct

All Implemented Interfaces:: Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, StructOrBuilder, Serializable

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

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

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

Fields
Modifier and Type	Field and Description
`static int`	`FIELDS_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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 Descriptors.Descriptor`	`getDescriptor()`
`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()` 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(InputStream input)`
`static Struct`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Struct`	`parseFrom(byte[] data)`
`static Struct`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Struct`	`parseFrom(ByteBuffer data)`
`static Struct`	`parseFrom(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(InputStream input)`
`static Struct`	`parseFrom(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`.

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 UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class GeneratedMessageV3
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetMapField
```
protected MapField internalGetMapField(int number)
```
    Description copied from class: GeneratedMessageV3
    
    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:
    
    internalGetMapField in class GeneratedMessageV3
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3
    
    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 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(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 GeneratedMessageV3
  - 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 GeneratedMessageV3
    
    Throws:
    
    IOException
  - 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.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class GeneratedMessageV3
  - 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(GeneratedMessageV3.BuilderParent parent)
```
    Description copied from class: GeneratedMessageV3
    
    TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
    
    Specified by:
    
    newBuilderForType in class GeneratedMessageV3
  - getDefaultInstance
```
public static Struct getDefaultInstance()
```
  - parser
```
public static Parser<Struct> parser()
```
  - getParserForType
```
public Parser<Struct> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class GeneratedMessageV3
  - 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

Class Struct

Nested Class Summary

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

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

FIELDS_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

internalGetMapField

internalGetFieldAccessorTable

getFieldsCount

containsFields

getFields

getFieldsMap

getFieldsOrDefault

getFieldsOrThrow

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType