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.

Generated

from message google.protobuf.Struct

Hierarchy

Constructors

  • Parameters

    Returns Struct

Properties

fields: {
    [key: string]: Value;
}

Unordered map of dynamically typed values.

Generated

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

Type declaration

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.Struct" = "google.protobuf.Struct"

Methods

  • Create a deep copy.

    Returns Struct

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    Returns Struct

  • Parse a message from a JSON value.

    Parameters

    Returns Struct

  • Parse a message from a JSON string.

    Parameters

    Returns Struct

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<Struct>

  • Serialize the message to binary data.

    Parameters

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    Returns string

  • Parameters

    Returns boolean

  • Parameters

    Returns Struct

  • Parameters

    Returns Struct

  • Parameters

    Returns Struct

Generated using TypeDoc