Constructor
new FileOptions(propertiesopt)
Constructs a new FileOptions.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.protobuf.IFileOptions |
<optional> |
Properties to set |
- Implements:
-
- IFileOptions
Members
ccEnableArenas
FileOptions ccEnableArenas.
ccGenericServices
FileOptions ccGenericServices.
csharpNamespace
FileOptions csharpNamespace.
deprecated
FileOptions deprecated.
features
FileOptions features.
goPackage
FileOptions goPackage.
javaGenerateEqualsAndHash
FileOptions javaGenerateEqualsAndHash.
javaGenericServices
FileOptions javaGenericServices.
javaMultipleFiles
FileOptions javaMultipleFiles.
javaOuterClassname
FileOptions javaOuterClassname.
javaPackage
FileOptions javaPackage.
javaStringCheckUtf8
FileOptions javaStringCheckUtf8.
objcClassPrefix
FileOptions objcClassPrefix.
optimizeFor
FileOptions optimizeFor.
phpClassPrefix
FileOptions phpClassPrefix.
phpMetadataNamespace
FileOptions phpMetadataNamespace.
phpNamespace
FileOptions phpNamespace.
pyGenericServices
FileOptions pyGenericServices.
rubyPackage
FileOptions rubyPackage.
swiftPrefix
FileOptions swiftPrefix.
uninterpretedOption
FileOptions uninterpretedOption.
OptimizeMode
OptimizeMode enum.
Properties:
| Name | Type | Description |
|---|---|---|
SPEED |
number |
SPEED value |
CODE_SIZE |
number |
CODE_SIZE value |
LITE_RUNTIME |
number |
LITE_RUNTIME value |
Methods
toJSON() → {Object.<string, *>}
Converts this FileOptions to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.protobuf.FileOptions}
Creates a new FileOptions instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.protobuf.IFileOptions |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.protobuf.FileOptions |
FileOptions instance |
(static) decode(reader, lengthopt) → {google.protobuf.FileOptions}
Decodes a FileOptions message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.protobuf.FileOptions |
FileOptions |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.protobuf.FileOptions}
Decodes a FileOptions message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.protobuf.FileOptions |
FileOptions |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified FileOptions message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.protobuf.IFileOptions |
FileOptions message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified FileOptions message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.protobuf.IFileOptions |
FileOptions message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.protobuf.FileOptions}
Creates a FileOptions message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.protobuf.FileOptions |
FileOptions |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for FileOptions
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a FileOptions message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.protobuf.FileOptions |
FileOptions |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a FileOptions message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|