FileOptions

google.protobuf. FileOptions

Represents a FileOptions.

Constructor

new FileOptions(propertiesopt)

Constructs a new FileOptions.

Parameters:
Name Type Attributes Description
properties google.protobuf.IFileOptions <optional>

Properties to set

Implements:
  • IFileOptions

Members

(static) OptimizeMode :string

OptimizeMode enum.

Properties:
Name Type Description
SPEED number

SPEED value

CODE_SIZE number

CODE_SIZE value

LITE_RUNTIME number

LITE_RUNTIME value

ccEnableArenas :boolean

FileOptions ccEnableArenas.

ccGenericServices :boolean

FileOptions ccGenericServices.

csharpNamespace :string

FileOptions csharpNamespace.

deprecated :boolean

FileOptions deprecated.

goPackage :string

FileOptions goPackage.

javaGenerateEqualsAndHash :boolean

FileOptions javaGenerateEqualsAndHash.

javaGenericServices :boolean

FileOptions javaGenericServices.

javaMultipleFiles :boolean

FileOptions javaMultipleFiles.

javaOuterClassname :string

FileOptions javaOuterClassname.

javaPackage :string

FileOptions javaPackage.

javaStringCheckUtf8 :boolean

FileOptions javaStringCheckUtf8.

objcClassPrefix :string

FileOptions objcClassPrefix.

optimizeFor :google.protobuf.FileOptions.OptimizeMode

FileOptions optimizeFor.

phpClassPrefix :string

FileOptions phpClassPrefix.

phpGenericServices :boolean

FileOptions phpGenericServices.

phpMetadataNamespace :string

FileOptions phpMetadataNamespace.

phpNamespace :string

FileOptions phpNamespace.

pyGenericServices :boolean

FileOptions pyGenericServices.

rubyPackage :string

FileOptions rubyPackage.

swiftPrefix :string

FileOptions swiftPrefix.

uninterpretedOption :Array.<google.protobuf.IUninterpretedOption>

FileOptions uninterpretedOption.

Methods

(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

(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

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

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

(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

(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

(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

(static) verify(message) → {string|null}

Verifies a FileOptions message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this FileOptions to JSON.