Class: FileOptions

google.protobuf.FileOptions

Represents a FileOptions.

Implements

• IFileOptions

Constructors

constructor

• new FileOptions(properties?): FileOptions

Constructs a new FileOptions.

Parameters

Name	Type	Description
properties?	IFileOptions	Properties to set

Returns

FileOptions

Properties

ccEnableArenas

• ccEnableArenas: boolean

FileOptions ccEnableArenas.

Implementation of

IFileOptions.ccEnableArenas

---

ccGenericServices

• ccGenericServices: boolean

FileOptions ccGenericServices.

Implementation of

IFileOptions.ccGenericServices

---

csharpNamespace

• csharpNamespace: string

FileOptions csharpNamespace.

Implementation of

IFileOptions.csharpNamespace

---

deprecated

• deprecated: boolean

FileOptions deprecated.

Implementation of

IFileOptions.deprecated

---

goPackage

• goPackage: string

FileOptions goPackage.

Implementation of

IFileOptions.goPackage

---

javaGenerateEqualsAndHash

• javaGenerateEqualsAndHash: boolean

FileOptions javaGenerateEqualsAndHash.

Implementation of

IFileOptions.javaGenerateEqualsAndHash

---

javaGenericServices

• javaGenericServices: boolean

FileOptions javaGenericServices.

Implementation of

IFileOptions.javaGenericServices

---

javaMultipleFiles

• javaMultipleFiles: boolean

FileOptions javaMultipleFiles.

Implementation of

IFileOptions.javaMultipleFiles

---

javaOuterClassname

• javaOuterClassname: string

FileOptions javaOuterClassname.

Implementation of

IFileOptions.javaOuterClassname

---

javaPackage

• javaPackage: string

FileOptions javaPackage.

Implementation of

IFileOptions.javaPackage

---

javaStringCheckUtf8

• javaStringCheckUtf8: boolean

FileOptions javaStringCheckUtf8.

Implementation of

IFileOptions.javaStringCheckUtf8

---

objcClassPrefix

• objcClassPrefix: string

FileOptions objcClassPrefix.

Implementation of

IFileOptions.objcClassPrefix

---

optimizeFor

• optimizeFor: OptimizeMode

FileOptions optimizeFor.

Implementation of

IFileOptions.optimizeFor

---

pyGenericServices

• pyGenericServices: boolean

FileOptions pyGenericServices.

Implementation of

IFileOptions.pyGenericServices

---

uninterpretedOption

• uninterpretedOption: IUninterpretedOption[]

FileOptions uninterpretedOption.

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

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

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

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

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