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

Implements

StructOrBuilder

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

newBuilder()

  public 
  
 static 
  
 Struct 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Struct prototype)

  public 
  
 static 
  
 Struct 
 . 
 Builder 
  
 newBuilder 
 ( 
 Struct 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Struct 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Struct 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Struct 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<Struct> 
  
 parser 
 () 
 
Returns
Type
Description

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
Returns
Type
Description

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
arg0
arg1
Returns
Type
Description
Overrides

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
defaultValue
Returns
Type
Description

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
Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: