Class CodeGeneratorResponse

The plugin writes an encoded CodeGeneratorResponse to stdout.

Generated

from message google.protobuf.compiler.CodeGeneratorResponse

Hierarchy (view full)

Constructors

Properties

error?: string

Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way.

This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code.

Generated

from field: optional string error = 1;

Generated

from field: repeated google.protobuf.compiler.CodeGeneratorResponse.File file = 15;

maximumEdition?: number

The maximum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, not the edition number. Only takes effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.

Generated

from field: optional int32 maximum_edition = 4;

minimumEdition?: number

The minimum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, not the edition number. Only takes effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.

Generated

from field: optional int32 minimum_edition = 3;

supportedFeatures?: bigint

A bitmask of supported features that the code generator supports. This is a bitwise "or" of values from the Feature enum.

Generated

from field: optional uint64 supported_features = 2;

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.compiler.CodeGeneratorResponse" = "google.protobuf.compiler.CodeGeneratorResponse"

Methods

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

    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<CodeGeneratorResponse>

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

  • Parameters

    Returns CodeGeneratorResponse