Class Struct (3.19.4)

public final class Struct extends GeneratedMessageLite<Struct,Struct.Builder> 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > GeneratedMessageLite > Struct

Implements

StructOrBuilder

Inherited Members

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageLite.<ContainingType,Type>newRepeatedGeneratedExtension(ContainingType,MessageLite,Internal.EnumLiteMap<?>,int,WireFormat.FieldType,boolean,Class)

GeneratedMessageLite.<ContainingType,Type>newSingularGeneratedExtension(ContainingType,Type,MessageLite,Internal.EnumLiteMap<?>,int,WireFormat.FieldType,Class)

GeneratedMessageLite.<E>emptyProtobufList()

GeneratedMessageLite.<E>mutableCopy(Internal.ProtobufList<E>)

GeneratedMessageLite.<MessageType,BuilderType>createBuilder()

GeneratedMessageLite.<MessageType,BuilderType>createBuilder(MessageType)

GeneratedMessageLite.<T>isInitialized(T,boolean)

GeneratedMessageLite.<T>parseDelimitedFrom(T,InputStream)

GeneratedMessageLite.<T>parseDelimitedFrom(T,InputStream,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,byte[])

GeneratedMessageLite.<T>parseFrom(T,byte[],ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,ByteString)

GeneratedMessageLite.<T>parseFrom(T,ByteString,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,CodedInputStream)

GeneratedMessageLite.<T>parseFrom(T,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,InputStream)

GeneratedMessageLite.<T>parseFrom(T,InputStream,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,ByteBuffer)

GeneratedMessageLite.<T>parseFrom(T,ByteBuffer,ExtensionRegistryLite)

GeneratedMessageLite.<T>parsePartialFrom(T,CodedInputStream)

GeneratedMessageLite.<T>registerDefaultInstance(Class<T>,T)

GeneratedMessageLite.dynamicMethod(GeneratedMessageLite.MethodToInvoke)

GeneratedMessageLite.dynamicMethod(GeneratedMessageLite.MethodToInvoke,Object)

GeneratedMessageLite.dynamicMethod(GeneratedMessageLite.MethodToInvoke,Object,Object)

GeneratedMessageLite.emptyBooleanList()

GeneratedMessageLite.emptyDoubleList()

GeneratedMessageLite.emptyFloatList()

GeneratedMessageLite.emptyIntList()

GeneratedMessageLite.emptyLongList()

GeneratedMessageLite.equals(Object)

GeneratedMessageLite.getDefaultInstanceForType()

GeneratedMessageLite.getParserForType()

GeneratedMessageLite.getSerializedSize()

GeneratedMessageLite.hashCode()

GeneratedMessageLite.isInitialized()

GeneratedMessageLite.makeImmutable()

GeneratedMessageLite.mergeLengthDelimitedField(int,ByteString)

GeneratedMessageLite.mergeUnknownFields(UnknownFieldSetLite)

GeneratedMessageLite.mergeVarintField(int,int)

GeneratedMessageLite.mutableCopy(Internal.BooleanList)

GeneratedMessageLite.mutableCopy(Internal.DoubleList)

GeneratedMessageLite.mutableCopy(Internal.FloatList)

GeneratedMessageLite.mutableCopy(Internal.IntList)

GeneratedMessageLite.mutableCopy(Internal.LongList)

GeneratedMessageLite.newBuilderForType()

GeneratedMessageLite.newMessageInfo(MessageLite,String,Object[])

GeneratedMessageLite.parseUnknownField(int,CodedInputStream)

GeneratedMessageLite.toBuilder()

GeneratedMessageLite.toString()

GeneratedMessageLite.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Struct getDefaultInstance()

Returns
Type	Description
`Struct`

newBuilder()

public static Struct.Builder newBuilder()

Returns
Type	Description
`Struct.Builder`

newBuilder(Struct prototype)

public static Struct.Builder newBuilder(Struct prototype)

Parameter
Name	Description
`prototype`	`Struct`

Returns
Type	Description
`Struct.Builder`

parseDelimitedFrom(InputStream input)

public static Struct parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Struct parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Struct parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Struct parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Struct parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Struct parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Struct parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Struct`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Struct> parser()

Returns
Type	Description
`Parser<Struct>`

Methods

containsFields(String key)

public boolean containsFields(String key)

Unordered map of dynamically typed values.

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

A method that implements different types of operations described in MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.

NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
NEW_BUILDER returns a BuilderType instance.

This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

For use by generated code only.

Parameters
Name	Description
`method`	`GeneratedMessageLite.MethodToInvoke`
`arg0`	`Object`
`arg1`	`Object`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageLite<MessageType,BuilderType>.dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

getFields()

public Map<String,Value> getFields()

Use #getFieldsMap() instead.

Returns
Type	Description
`Map<String,Value>`

getFieldsCount()

public int getFieldsCount()

Unordered map of dynamically typed values.

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

Returns
Type	Description
`int`

getFieldsMap()

public Map<String,Value> getFieldsMap()

Unordered map of dynamically typed values.

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

Returns
Type	Description
`Map<String,Value>`

getFieldsOrDefault(String key, Value defaultValue)

public Value getFieldsOrDefault(String key, Value defaultValue)

Unordered map of dynamically typed values.

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

Parameters
Name	Description
`key`	`String`
`defaultValue`	`Value`

Returns
Type	Description
`Value`

getFieldsOrThrow(String key)

public Value getFieldsOrThrow(String key)

Unordered map of dynamically typed values.

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Value`