Class: Struct

Struct(opt_dataopt)

new Struct(opt_dataopt)

Generated by JsPbCodeGenerator.
Parameters:
Name Type Attributes Description
opt_data Array <optional>
 Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.
Source:

Extends

  • jspb.Message

Members

(static) displayName

Source:

Methods

clearFieldsMap() → (non-null) {proto.google.protobuf.Struct}

Clears values from the map. The map will be non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.Struct

getFieldsMap(opt_noLazyCreateopt) → (non-null) {jspb.Map.<string, !proto.google.protobuf.Value>}

map fields = 1;
Parameters:
Name Type Attributes Description
opt_noLazyCreate boolean <optional>
 Do not create the map if empty, instead returning `undefined`
Source:
Returns:
Type
jspb.Map.<string, !proto.google.protobuf.Value>

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

toJavaScript() → (non-null) {Object.<string, !proto.google.protobuf.JavaScriptValue>}

Converts this Struct object to a plain JavaScript object.
Source:
Returns:
a plain JavaScript object representing this Struct.
Type
Object.<string, !proto.google.protobuf.JavaScriptValue>

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.
Parameters:
Name Type Attributes Description
opt_includeInstance boolean <optional>
 Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
Source:
Returns:
Type
Object

(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.Struct}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.google.protobuf.Struct

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.Struct}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.google.protobuf.Struct The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.google.protobuf.Struct

(static) fromJavaScript(objnon-null) → {proto.google.protobuf.Struct}

Constructs a Struct protobuf from this plain JavaScript object.
Parameters:
Name Type Description
obj Object a plain JavaScript object
Source:
Returns:
a new Struct object
Type
proto.google.protobuf.Struct

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.
Parameters:
Name Type Description
message proto.google.protobuf.Struct
writer jspb.BinaryWriter
Source:

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.
Parameters:
Name Type Description
includeInstance boolean | undefined Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
msg proto.google.protobuf.Struct The msg instance to transform.
Source:
Returns:
Type
Object