new FileOptions(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. |
Extends
- jspb.Message
Members
(static) OptimizeMode :number
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
SPEED |
number | |
CODE_SIZE |
number | |
LITE_RUNTIME |
number |
(static) displayName
(static, non-null) extensions :Object.<number, jspb.ExtensionFieldInfo>
The extensions registered with this message class. This is a map of
extension field number to fieldInfo object.
For example:
{ 123: {fieldIndex: 123, fieldName: {my_field_name: 0}, ctor: proto.example.MyMessage} }
fieldName contains the JsCompiler renamed field name property so that it
works in OPTIMIZED mode.
Type:
- Object.<number, jspb.ExtensionFieldInfo>
(static, non-null) extensionsBinary :Object.<number, jspb.ExtensionFieldBinaryInfo>
The extensions registered with this message class. This is a map of
extension field number to fieldInfo object.
For example:
{ 123: {fieldIndex: 123, fieldName: {my_field_name: 0}, ctor: proto.example.MyMessage} }
fieldName contains the JsCompiler renamed field name property so that it
works in OPTIMIZED mode.
Type:
- Object.<number, jspb.ExtensionFieldBinaryInfo>
Methods
addUninterpretedOption(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.UninterpretedOption}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_value |
proto.google.protobuf.UninterpretedOption |
<optional> |
|
opt_index |
number |
<optional> |
Returns:
clearCcEnableArenas() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearCcGenericServices() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearCsharpNamespace() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearDeprecated() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearGoPackage() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearJavaGenerateEqualsAndHash() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearJavaGenericServices() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearJavaMultipleFiles() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearJavaOuterClassname() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearJavaPackage() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearJavaStringCheckUtf8() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearObjcClassPrefix() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearOptimizeFor() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearPhpClassPrefix() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearPhpGenericServices() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearPhpMetadataNamespace() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearPhpNamespace() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearPyGenericServices() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearRubyPackage() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearSwiftPrefix() → (non-null) {proto.google.protobuf.FileOptions}
Clears the field making it undefined.
Returns:
returns this
clearUninterpretedOptionList() → (non-null) {proto.google.protobuf.FileOptions}
Clears the list making it empty but non-null.
Returns:
returns this
getCcEnableArenas() → {boolean}
optional bool cc_enable_arenas = 31;
Returns:
- Type
- boolean
getCcGenericServices() → {boolean}
optional bool cc_generic_services = 16;
Returns:
- Type
- boolean
getCsharpNamespace() → {string}
optional string csharp_namespace = 37;
Returns:
- Type
- string
getDeprecated() → {boolean}
optional bool deprecated = 23;
Returns:
- Type
- boolean
getGoPackage() → {string}
optional string go_package = 11;
Returns:
- Type
- string
getJavaGenerateEqualsAndHash() → {boolean}
optional bool java_generate_equals_and_hash = 20;
Returns:
- Type
- boolean
getJavaGenericServices() → {boolean}
optional bool java_generic_services = 17;
Returns:
- Type
- boolean
getJavaMultipleFiles() → {boolean}
optional bool java_multiple_files = 10;
Returns:
- Type
- boolean
getJavaOuterClassname() → {string}
optional string java_outer_classname = 8;
Returns:
- Type
- string
getJavaPackage() → {string}
optional string java_package = 1;
Returns:
- Type
- string
getJavaStringCheckUtf8() → {boolean}
optional bool java_string_check_utf8 = 27;
Returns:
- Type
- boolean
getObjcClassPrefix() → {string}
optional string objc_class_prefix = 36;
Returns:
- Type
- string
getOptimizeFor() → (non-null) {proto.google.protobuf.FileOptions.OptimizeMode}
optional OptimizeMode optimize_for = 9;
Returns:
getPhpClassPrefix() → {string}
optional string php_class_prefix = 40;
Returns:
- Type
- string
getPhpGenericServices() → {boolean}
optional bool php_generic_services = 42;
Returns:
- Type
- boolean
getPhpMetadataNamespace() → {string}
optional string php_metadata_namespace = 44;
Returns:
- Type
- string
getPhpNamespace() → {string}
optional string php_namespace = 41;
Returns:
- Type
- string
getPyGenericServices() → {boolean}
optional bool py_generic_services = 18;
Returns:
- Type
- boolean
getRubyPackage() → {string}
optional string ruby_package = 45;
Returns:
- Type
- string
getSwiftPrefix() → {string}
optional string swift_prefix = 39;
Returns:
- Type
- string
getUninterpretedOptionList() → (non-null) {Array.<!proto.google.protobuf.UninterpretedOption>}
repeated UninterpretedOption uninterpreted_option = 999;
Returns:
- Type
- Array.<!proto.google.protobuf.UninterpretedOption>
hasCcEnableArenas() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasCcGenericServices() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasCsharpNamespace() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasDeprecated() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasGoPackage() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJavaGenerateEqualsAndHash() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJavaGenericServices() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJavaMultipleFiles() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJavaOuterClassname() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJavaPackage() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJavaStringCheckUtf8() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasObjcClassPrefix() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasOptimizeFor() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPhpClassPrefix() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPhpGenericServices() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPhpMetadataNamespace() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPhpNamespace() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPyGenericServices() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasRubyPackage() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasSwiftPrefix() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
serializeBinary() → (non-null) {Uint8Array}
Serializes the message to binary data (in protobuf wire format).
Returns:
- Type
- Uint8Array
setCcEnableArenas(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setCcGenericServices(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setCsharpNamespace(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setDeprecated(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setGoPackage(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setJavaGenerateEqualsAndHash(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setJavaGenericServices(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setJavaMultipleFiles(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setJavaOuterClassname(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setJavaPackage(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setJavaStringCheckUtf8(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setObjcClassPrefix(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setOptimizeFor(valuenon-null) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.FileOptions.OptimizeMode |
Returns:
returns this
setPhpClassPrefix(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setPhpGenericServices(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setPhpMetadataNamespace(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setPhpNamespace(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setPyGenericServices(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setRubyPackage(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setSwiftPrefix(value) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setUninterpretedOptionList(valuenon-null) → (non-null) {proto.google.protobuf.FileOptions}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array.<!proto.google.protobuf.UninterpretedOption> |
Returns:
returns this
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 |
Returns:
- Type
- Object
(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.FileOptions}
Deserializes binary data (in protobuf wire format).
Parameters:
| Name | Type | Description |
|---|---|---|
bytes |
jspb.ByteSource | The bytes to deserialize. |
Returns:
(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.FileOptions}
Deserializes binary data (in protobuf wire format) from the
given reader into the given message object.
Parameters:
| Name | Type | Description |
|---|---|---|
msg |
proto.google.protobuf.FileOptions | The message object to deserialize into. |
reader |
jspb.BinaryReader | The BinaryReader to use. |
Returns:
(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.FileOptions | |
writer |
jspb.BinaryWriter |
(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.FileOptions | The msg instance to transform. |
Returns:
- Type
- Object