Class Struct

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

constructor

  • new Struct(data?: PartialMessage<Struct>): Struct

    Parameters

    • Optionaldata: PartialMessage<Struct>

    Returns Struct

Properties

fields

fields: { [key: string]: Value }

Unordered map of dynamically typed values.

Generated

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

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "google.protobuf.Struct"

Methods

clone

  • clone(): Struct

    Create a deep copy.

    Returns Struct

equals

  • equals(other: undefined | null | Struct | PlainMessage<Struct>): boolean

    Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

    Parameters

    Returns boolean

fromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this

    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

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON value.

    Parameters

    • json: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<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>

toBinary

  • toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array

    Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

toJson

  • toJson(options?: Partial<JsonWriteOptions>): JsonValue

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

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

ProtectedtoJSON

  • toJSON(): JsonValue

    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

toJsonString

  • toJsonString(options?: Partial<JsonWriteStringOptions>): string

    Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

Staticequals

StaticfromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Struct

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns Struct

StaticfromJson

  • fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Struct

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Struct

StaticfromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Struct

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Struct

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR