Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

Generated

from message google.protobuf.Value

Hierarchy (view full)

Constructors

  • Parameters

    Returns Value

Properties

kind: {
    case: "nullValue";
    value: NULL_VALUE;
} | {
    case: "numberValue";
    value: number;
} | {
    case: "stringValue";
    value: string;
} | {
    case: "boolValue";
    value: boolean;
} | {
    case: "structValue";
    value: Struct;
} | {
    case: "listValue";
    value: ListValue;
} | {
    case: undefined;
    value?: undefined;
}

The kind of value.

Type declaration

  • case: "nullValue"
  • value: NULL_VALUE

    Represents a null value.

    Generated

    from field: google.protobuf.NullValue null_value = 1;

Type declaration

  • case: "numberValue"
  • value: number

    Represents a double value.

    Generated

    from field: double number_value = 2;

Type declaration

  • case: "stringValue"
  • value: string

    Represents a string value.

    Generated

    from field: string string_value = 3;

Type declaration

  • case: "boolValue"
  • value: boolean

    Represents a boolean value.

    Generated

    from field: bool bool_value = 4;

Type declaration

  • case: "structValue"
  • value: Struct

    Represents a structured value.

    Generated

    from field: google.protobuf.Struct struct_value = 5;

Type declaration

  • case: "listValue"
  • value: ListValue

    Represents a repeated Value.

    Generated

    from field: google.protobuf.ListValue list_value = 6;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof google.protobuf.Value.kind

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

Methods

  • Create a deep copy.

    Returns Value

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

    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 this

  • Parse a message from a JSON value.

    Parameters

    Returns this

  • Parse a message from a JSON string.

    Parameters

    Returns this

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

    Returns MessageType<Value>

  • 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

  • Returns boolean

  • Parameters

    Returns Value

  • Parameters

    Returns Value

  • Parameters

    Returns Value