JSDoc: Class: FileDescriptorProto

new FileDescriptorProto(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:

proto/google/protobuf/descriptor_pb.js, line 79

Extends

jspb.Message

Members

(static) displayName

Source:

proto/google/protobuf/descriptor_pb.js, line 88

Methods

addDependency(value, opt_indexopt) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Attributes	Description
`value`	string
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1407

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

addEnumType(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.EnumDescriptorProto	<optional>
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1557

Returns:

Type: proto.google.protobuf.EnumDescriptorProto

addExtension$(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.FieldDescriptorProto}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.FieldDescriptorProto	<optional>
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1633

Returns:

Type: proto.google.protobuf.FieldDescriptorProto

addMessageType(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.DescriptorProto	<optional>
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1519

Returns:

Type: proto.google.protobuf.DescriptorProto

addPublicDependency(value, opt_indexopt) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Attributes	Description
`value`	number
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1444

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

addService(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.ServiceDescriptorProto}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.ServiceDescriptorProto	<optional>
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1595

Returns:

Type: proto.google.protobuf.ServiceDescriptorProto

addWeakDependency(value, opt_indexopt) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Attributes	Description
`value`	number
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 1481

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearDependencyList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1416

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearEnumTypeList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1566

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearExtensionList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1642

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearMessageTypeList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1528

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearName() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 1334

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearOptions() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the message field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 1670

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearPackage() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 1370

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearPublicDependencyList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1453

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearServiceList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1604

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearSourceCodeInfo() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the message field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 1707

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearSyntax() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 1743

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

clearWeakDependencyList() → (non-null) {proto.google.protobuf.FileDescriptorProto}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 1490

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

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

repeated string dependency = 3;

Source:

proto/google/protobuf/descriptor_pb.js, line 1388

Returns:

Type: Array.<string>

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

repeated EnumDescriptorProto enum_type = 5;

Source:

proto/google/protobuf/descriptor_pb.js, line 1537

Returns:

Type: Array.<!proto.google.protobuf.EnumDescriptorProto>

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

repeated FieldDescriptorProto extension = 7;

Source:

proto/google/protobuf/descriptor_pb.js, line 1613

Returns:

Type: Array.<!proto.google.protobuf.FieldDescriptorProto>

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

repeated DescriptorProto message_type = 4;

Source:

proto/google/protobuf/descriptor_pb.js, line 1499

Returns:

Type: Array.<!proto.google.protobuf.DescriptorProto>

getName() → {string}

optional string name = 1;

Source:

proto/google/protobuf/descriptor_pb.js, line 1316

Returns:

Type: string

getOptions() → (nullable) {proto.google.protobuf.FileOptions}

optional FileOptions options = 8;

Source:

proto/google/protobuf/descriptor_pb.js, line 1651

Returns:

Type: proto.google.protobuf.FileOptions

getPackage() → {string}

optional string package = 2;

Source:

proto/google/protobuf/descriptor_pb.js, line 1352

Returns:

Type: string

getPublicDependencyList() → (non-null) {Array.<number>}

repeated int32 public_dependency = 10;

Source:

proto/google/protobuf/descriptor_pb.js, line 1425

Returns:

Type: Array.<number>

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

repeated ServiceDescriptorProto service = 6;

Source:

proto/google/protobuf/descriptor_pb.js, line 1575

Returns:

Type: Array.<!proto.google.protobuf.ServiceDescriptorProto>

getSourceCodeInfo() → (nullable) {proto.google.protobuf.SourceCodeInfo}

optional SourceCodeInfo source_code_info = 9;

Source:

proto/google/protobuf/descriptor_pb.js, line 1688

Returns:

Type: proto.google.protobuf.SourceCodeInfo

getSyntax() → {string}

optional string syntax = 12;

Source:

proto/google/protobuf/descriptor_pb.js, line 1725

Returns:

Type: string

getWeakDependencyList() → (non-null) {Array.<number>}

repeated int32 weak_dependency = 11;

Source:

proto/google/protobuf/descriptor_pb.js, line 1462

Returns:

Type: Array.<number>

hasName() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 1343

Returns:

Type: boolean

hasOptions() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 1679

Returns:

Type: boolean

hasPackage() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 1379

Returns:

Type: boolean

hasSourceCodeInfo() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 1716

Returns:

Type: boolean

hasSyntax() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 1752

Returns:

Type: boolean

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

Serializes the message to binary data (in protobuf wire format).

Source:

proto/google/protobuf/descriptor_pb.js, line 1203

Returns:

Type: Uint8Array

setDependencyList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

proto/google/protobuf/descriptor_pb.js, line 1397

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setEnumTypeList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.EnumDescriptorProto>

Source:

proto/google/protobuf/descriptor_pb.js, line 1547

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setExtensionList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.FieldDescriptorProto>

Source:

proto/google/protobuf/descriptor_pb.js, line 1623

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setMessageTypeList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.DescriptorProto>

Source:

proto/google/protobuf/descriptor_pb.js, line 1509

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setName(value) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/descriptor_pb.js, line 1325

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setOptions(value) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.FileOptions \| undefined

Source:

proto/google/protobuf/descriptor_pb.js, line 1661

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setPackage(value) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/descriptor_pb.js, line 1361

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setPublicDependencyList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<number>

Source:

proto/google/protobuf/descriptor_pb.js, line 1434

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setServiceList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.ServiceDescriptorProto>

Source:

proto/google/protobuf/descriptor_pb.js, line 1585

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setSourceCodeInfo(value) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.SourceCodeInfo \| undefined

Source:

proto/google/protobuf/descriptor_pb.js, line 1698

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setSyntax(value) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/descriptor_pb.js, line 1734

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

setWeakDependencyList(valuenon-null) → (non-null) {proto.google.protobuf.FileDescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<number>

Source:

proto/google/protobuf/descriptor_pb.js, line 1471

Returns:

returns this

Type: proto.google.protobuf.FileDescriptorProto

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:

proto/google/protobuf/descriptor_pb.js, line 1068

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

proto/google/protobuf/descriptor_pb.js, line 1115

Returns:

Type: proto.google.protobuf.FileDescriptorProto

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

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.google.protobuf.FileDescriptorProto	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

proto/google/protobuf/descriptor_pb.js, line 1129

Returns:

Type: proto.google.protobuf.FileDescriptorProto

(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.FileDescriptorProto
`writer`	jspb.BinaryWriter

Source:

proto/google/protobuf/descriptor_pb.js, line 1217

(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.FileDescriptorProto	The msg instance to transform.

Source:

proto/google/protobuf/descriptor_pb.js, line 1082

Returns:

Type: Object