Class: CodeGeneratorRequest

CodeGeneratorRequest(opt_dataopt)

new CodeGeneratorRequest(opt_dataopt)

Generated by JsPbCodeGenerator.
Parameters:
Name Type Attributes Description
opt_data Array <optional>
 Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.
Source:

Extends

  • jspb.Message

Members

(static) displayName

Source:

Methods

addFileToGenerate(value, opt_indexopt) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Parameters:
Name Type Attributes Description
value string
opt_index number <optional>
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

addProtoFile(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:
Name Type Attributes Description
opt_value proto.google.protobuf.FileDescriptorProto <optional>
opt_index number <optional>
Source:
Returns:
Type
proto.google.protobuf.FileDescriptorProto

clearCompilerVersion() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

clearFileToGenerateList() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

clearParameter() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Clears the field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

clearProtoFileList() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

getCompilerVersion() → (nullable) {proto.google.protobuf.compiler.Version}

optional Version compiler_version = 3;
Source:
Returns:
Type
proto.google.protobuf.compiler.Version

getFileToGenerateList() → (non-null) {Array.<string>}

repeated string file_to_generate = 1;
Source:
Returns:
Type
Array.<string>

getParameter() → {string}

optional string parameter = 2;
Source:
Returns:
Type
string

getProtoFileList() → (non-null) {Array.<!proto.google.protobuf.FileDescriptorProto>}

repeated google.protobuf.FileDescriptorProto proto_file = 15;
Source:
Returns:
Type
Array.<!proto.google.protobuf.FileDescriptorProto>

hasCompilerVersion() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasParameter() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setCompilerVersion(value) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Parameters:
Name Type Description
value proto.google.protobuf.compiler.Version | undefined
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

setFileToGenerateList(valuenon-null) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Parameters:
Name Type Description
value Array.<string>
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

setParameter(value) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

setProtoFileList(valuenon-null) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Parameters:
Name Type Description
value Array.<!proto.google.protobuf.FileDescriptorProto>
Source:
Returns:
returns this
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.
Parameters:
Name Type Attributes Description
opt_includeInstance boolean <optional>
 Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
Source:
Returns:
Type
Object

(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorRequest}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.google.protobuf.compiler.CodeGeneratorRequest The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.google.protobuf.compiler.CodeGeneratorRequest

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.
Parameters:
Name Type Description
message proto.google.protobuf.compiler.CodeGeneratorRequest
writer jspb.BinaryWriter
Source:

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.
Parameters:
Name Type Description
includeInstance boolean | undefined Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
msg proto.google.protobuf.compiler.CodeGeneratorRequest The msg instance to transform.
Source:
Returns:
Type
Object