Class: FileOptions
Represents a FileOptions.
Implements
Constructors
constructor
• new FileOptions(properties?): FileOptions
Constructs a new FileOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFileOptions | Properties to set |
Returns
Properties
ccEnableArenas
• ccEnableArenas: boolean
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.
Implementation of
ccGenericServices
• ccGenericServices: boolean
Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins). Generic services were the only kind of service generation supported by early versions of google.protobuf.
Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.
Implementation of
IFileOptions.ccGenericServices
csharpNamespace
• csharpNamespace: string
Namespace for generated classes; defaults to the package.
Implementation of
deprecated
• deprecated: boolean
Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.
Implementation of
features
• Optional features: null | IFeatureSet
Any features defined in the specific edition.
Implementation of
goPackage
• goPackage: string
Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:
- The basename of the package import path, if provided.
- Otherwise, the package statement in the .proto file, if present.
- Otherwise, the basename of the .proto file, without extension.
Implementation of
javaGenerateEqualsAndHash
• javaGenerateEqualsAndHash: boolean
This option does nothing.
Implementation of
IFileOptions.javaGenerateEqualsAndHash
javaGenericServices
• javaGenericServices: boolean
FileOptions javaGenericServices.
Implementation of
IFileOptions.javaGenericServices
javaMultipleFiles
• javaMultipleFiles: boolean
If enabled, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will not be nested inside the wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.
Implementation of
IFileOptions.javaMultipleFiles
javaOuterClassname
• javaOuterClassname: string
Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.
Implementation of
IFileOptions.javaOuterClassname
javaPackage
• javaPackage: string
Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.
Implementation of
javaStringCheckUtf8
• javaStringCheckUtf8: boolean
If set true, then the Java2 code generator will generate code that throws an exception whenever an attempt is made to assign a non-UTF-8 byte sequence to a string field. Message reflection will do the same. However, an extension field still accepts non-UTF-8 byte sequences. This option has no effect on when used with the lite runtime.
Implementation of
IFileOptions.javaStringCheckUtf8
objcClassPrefix
• objcClassPrefix: string
Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.
Implementation of
optimizeFor
• optimizeFor: OptimizeMode
FileOptions optimizeFor.
Implementation of
phpClassPrefix
• phpClassPrefix: string
Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.
Implementation of
phpGenericServices
• phpGenericServices: boolean
FileOptions phpGenericServices.
Implementation of
IFileOptions.phpGenericServices
phpMetadataNamespace
• phpMetadataNamespace: string
Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace.
Implementation of
IFileOptions.phpMetadataNamespace
phpNamespace
• phpNamespace: string
Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.
Implementation of
pyGenericServices
• pyGenericServices: boolean
FileOptions pyGenericServices.
Implementation of
IFileOptions.pyGenericServices
rubyPackage
• rubyPackage: string
Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.
Implementation of
swiftPrefix
• swiftPrefix: string
By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.
Implementation of
uninterpretedOption
• uninterpretedOption: IUninterpretedOption[]
The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.
Implementation of
IFileOptions.uninterpretedOption
Methods
toJSON
▸ toJSON(): Object
Converts this FileOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): FileOptions
Creates a new FileOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFileOptions | Properties to set |
Returns
FileOptions instance
decode
▸ decode(reader, length?): FileOptions
Decodes a FileOptions message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
FileOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): FileOptions
Decodes a FileOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
FileOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified FileOptions message. Does not implicitly google.protobuf.FileOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFileOptions | FileOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified FileOptions message, length delimited. Does not implicitly google.protobuf.FileOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFileOptions | FileOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): FileOptions
Creates a FileOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
FileOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for FileOptions
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a FileOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | FileOptions | FileOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object