Class Struct (3.19.4)

publicfinalclass StructextendsGeneratedMessageLite<Struct,Struct.Builder>implementsStructOrBuilder

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

Inherited Members

Static Fields

FIELDS_FIELD_NUMBER

publicstaticfinalintFIELDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticStructgetDefaultInstance()
Returns
Type Description
Struct

newBuilder()

publicstaticStruct.BuildernewBuilder()
Returns
Type Description
Struct.Builder

newBuilder(Struct prototype)

publicstaticStruct.BuildernewBuilder(Structprototype)
Parameter
Name Description
prototype Struct
Returns
Type Description
Struct.Builder

parseDelimitedFrom(InputStream input)

publicstaticStructparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Struct
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticStructparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Struct
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticStructparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Struct
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticStructparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Struct
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticStructparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Struct
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticStructparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Struct
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticStructparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Struct
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticStructparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Struct
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticStructparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Struct
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticStructparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Struct
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticStructparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Struct
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticStructparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Struct
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Struct>parser()
Returns
Type Description
Parser<Struct>

Methods

containsFields(String key)

publicbooleancontainsFields(Stringkey)

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)

protectedfinalObjectdynamicMethod(GeneratedMessageLite.MethodToInvokemethod,Objectarg0,Objectarg1)

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

getFields()

publicMap<String,Value>getFields()

Use #getFieldsMap() instead.

Returns
Type Description
Map<String,Value>

getFieldsCount()

publicintgetFieldsCount()

Unordered map of dynamically typed values.

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

Returns
Type Description
int

getFieldsMap()

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

publicValuegetFieldsOrDefault(Stringkey,ValuedefaultValue)

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)

publicValuegetFieldsOrThrow(Stringkey)

Unordered map of dynamically typed values.

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

Parameter
Name Description
key String
Returns
Type Description
Value

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.