A single field of a message type.

Generated

from message google.protobuf.Field

Hierarchy

Constructors

  • Parameters

    Returns Field

Properties

cardinality: Field_Cardinality

The field cardinality.

Generated

from field: google.protobuf.Field.Cardinality cardinality = 2;

defaultValue: string

The string value of the default value of this field. Proto2 syntax only.

Generated

from field: string default_value = 11;

jsonName: string

The field JSON name.

Generated

from field: string json_name = 10;

The field type.

Generated

from field: google.protobuf.Field.Kind kind = 1;

name: string

The field name.

Generated

from field: string name = 4;

number: number

The field number.

Generated

from field: int32 number = 3;

oneofIndex: number

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Generated

from field: int32 oneof_index = 7;

options: Option[]

The protocol buffer options.

Generated

from field: repeated google.protobuf.Option options = 9;

packed: boolean

Whether to use alternative packed wire representation.

Generated

from field: bool packed = 8;

typeUrl: string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Generated

from field: string type_url = 6;

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

Methods

  • Create a deep copy.

    Returns Field

  • 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 Field

  • Parse a message from a JSON value.

    Parameters

    Returns Field

  • Parse a message from a JSON string.

    Parameters

    Returns Field

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

    Returns MessageType<Field>

  • 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 Field

  • Parameters

    Returns Field

  • Parameters

    Returns Field

Generated using TypeDoc