Class Struct

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

Implements

StructOrBuilder

Static Fields

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Struct getDefaultInstance()
Returns
TypeDescription
Struct

newBuilder()

public static Struct.Builder newBuilder()
Returns
TypeDescription
Struct.Builder

newBuilder(Struct prototype)

public static Struct.Builder newBuilder(Struct prototype)
Parameter
NameDescription
prototypeStruct
Returns
TypeDescription
Struct.Builder

parseDelimitedFrom(InputStream input)

public static Struct parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Struct
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Struct parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Struct
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Struct parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Struct
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Struct
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Struct parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Struct
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Struct
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Struct parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Struct
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Struct
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Struct parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Struct
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Struct
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Struct parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Struct
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Struct parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Struct
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Struct> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
methodGeneratedMessageLite.MethodToInvoke
arg0Object
arg1Object
Returns
TypeDescription
Object
Overrides

getFields()

public Map<String,Value> getFields()

Use #getFieldsMap() instead.

Returns
TypeDescription
Map<String,Value>

getFieldsCount()

public int getFieldsCount()

Unordered map of dynamically typed values.

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

Returns
TypeDescription
int

getFieldsMap()

public Map<String,Value> getFieldsMap()

Unordered map of dynamically typed values.

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

Returns
TypeDescription
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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getFieldsOrThrow(String key)

public Value getFieldsOrThrow(String key)

Unordered map of dynamically typed values.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Value