final case class FileOptions(javaPackage: scala.Option[String] = _root_.scala.None, javaOuterClassname: scala.Option[String] = _root_.scala.None, javaMultipleFiles: scala.Option[Boolean] = _root_.scala.None, javaGenerateEqualsAndHash: scala.Option[Boolean] = _root_.scala.None, javaStringCheckUtf8: scala.Option[Boolean] = _root_.scala.None, optimizeFor: scala.Option[OptimizeMode] = _root_.scala.None, goPackage: scala.Option[String] = _root_.scala.None, ccGenericServices: scala.Option[Boolean] = _root_.scala.None, javaGenericServices: scala.Option[Boolean] = _root_.scala.None, pyGenericServices: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, ccEnableArenas: scala.Option[Boolean] = _root_.scala.None, objcClassPrefix: scala.Option[String] = _root_.scala.None, csharpNamespace: scala.Option[String] = _root_.scala.None, swiftPrefix: scala.Option[String] = _root_.scala.None, phpClassPrefix: scala.Option[String] = _root_.scala.None, phpNamespace: scala.Option[String] = _root_.scala.None, phpMetadataNamespace: scala.Option[String] = _root_.scala.None, rubyPackage: scala.Option[String] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FileOptions] with ExtendableMessage[FileOptions] with Product with Serializable

javaPackage

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.

javaOuterClassname

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.

javaMultipleFiles

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.

javaGenerateEqualsAndHash

This option does nothing.

javaStringCheckUtf8

A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field. TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks.

goPackage

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.
ccGenericServices

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.

deprecated

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.

ccEnableArenas

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

objcClassPrefix

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

csharpNamespace

Namespace for generated classes; defaults to the package.

swiftPrefix

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.

phpClassPrefix

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

phpNamespace

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.

phpMetadataNamespace

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.

rubyPackage

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.

features

Any features defined in the specific edition.

uninterpretedOption

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

Annotations
@SerialVersionUID()
Linear Supertypes
ExtendableMessage[FileOptions], Updatable[FileOptions], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileOptions
  2. ExtendableMessage
  3. Updatable
  4. GeneratedMessage
  5. Serializable
  6. Serializable
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileOptions(javaPackage: scala.Option[String] = _root_.scala.None, javaOuterClassname: scala.Option[String] = _root_.scala.None, javaMultipleFiles: scala.Option[Boolean] = _root_.scala.None, javaGenerateEqualsAndHash: scala.Option[Boolean] = _root_.scala.None, javaStringCheckUtf8: scala.Option[Boolean] = _root_.scala.None, optimizeFor: scala.Option[OptimizeMode] = _root_.scala.None, goPackage: scala.Option[String] = _root_.scala.None, ccGenericServices: scala.Option[Boolean] = _root_.scala.None, javaGenericServices: scala.Option[Boolean] = _root_.scala.None, pyGenericServices: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, ccEnableArenas: scala.Option[Boolean] = _root_.scala.None, objcClassPrefix: scala.Option[String] = _root_.scala.None, csharpNamespace: scala.Option[String] = _root_.scala.None, swiftPrefix: scala.Option[String] = _root_.scala.None, phpClassPrefix: scala.Option[String] = _root_.scala.None, phpNamespace: scala.Option[String] = _root_.scala.None, phpMetadataNamespace: scala.Option[String] = _root_.scala.None, rubyPackage: scala.Option[String] = _root_.scala.None, features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...)

    javaPackage

    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.

    javaOuterClassname

    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.

    javaMultipleFiles

    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.

    javaGenerateEqualsAndHash

    This option does nothing.

    javaStringCheckUtf8

    A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field. TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks.

    goPackage

    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.
    ccGenericServices

    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.

    deprecated

    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.

    ccEnableArenas

    Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

    objcClassPrefix

    Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

    csharpNamespace

    Namespace for generated classes; defaults to the package.

    swiftPrefix

    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.

    phpClassPrefix

    Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

    phpNamespace

    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.

    phpMetadataNamespace

    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.

    rubyPackage

    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.

    features

    Any features defined in the specific edition.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): FileOptions
  5. def addUninterpretedOption(__vs: UninterpretedOption*): FileOptions
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val ccEnableArenas: scala.Option[Boolean]
  8. val ccGenericServices: scala.Option[Boolean]
  9. def clearCcEnableArenas: FileOptions
  10. def clearCcGenericServices: FileOptions
  11. def clearCsharpNamespace: FileOptions
  12. def clearDeprecated: FileOptions
  13. def clearFeatures: FileOptions
  14. def clearGoPackage: FileOptions
  15. def clearJavaGenerateEqualsAndHash: FileOptions
  16. def clearJavaGenericServices: FileOptions
  17. def clearJavaMultipleFiles: FileOptions
  18. def clearJavaOuterClassname: FileOptions
  19. def clearJavaPackage: FileOptions
  20. def clearJavaStringCheckUtf8: FileOptions
  21. def clearObjcClassPrefix: FileOptions
  22. def clearOptimizeFor: FileOptions
  23. def clearPhpClassPrefix: FileOptions
  24. def clearPhpMetadataNamespace: FileOptions
  25. def clearPhpNamespace: FileOptions
  26. def clearPyGenericServices: FileOptions
  27. def clearRubyPackage: FileOptions
  28. def clearSwiftPrefix: FileOptions
  29. def clearUninterpretedOption: FileOptions
  30. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. def companion: FileOptions.type
    Definition Classes
    FileOptions → GeneratedMessage
  32. val csharpNamespace: scala.Option[String]
  33. val deprecated: scala.Option[Boolean]
  34. def discardUnknownFields: FileOptions
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T
    Definition Classes
    ExtendableMessage
  37. val features: scala.Option[FeatureSet]
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def getCcEnableArenas: Boolean
  40. def getCcGenericServices: Boolean
  41. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. def getCsharpNamespace: String
  43. def getDeprecated: Boolean
  44. def getFeatures: FeatureSet
  45. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FileOptions → GeneratedMessage
  46. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    FileOptions → GeneratedMessage
  47. def getGoPackage: String
  48. def getJavaGenerateEqualsAndHash: Boolean
  49. def getJavaGenericServices: Boolean
  50. def getJavaMultipleFiles: Boolean
  51. def getJavaOuterClassname: String
  52. def getJavaPackage: String
  53. def getJavaStringCheckUtf8: Boolean
  54. def getObjcClassPrefix: String
  55. def getOptimizeFor: OptimizeMode
  56. def getPhpClassPrefix: String
  57. def getPhpMetadataNamespace: String
  58. def getPhpNamespace: String
  59. def getPyGenericServices: Boolean
  60. def getRubyPackage: String
  61. def getSwiftPrefix: String
  62. val goPackage: scala.Option[String]
  63. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  64. val javaGenericServices: scala.Option[Boolean]
  65. val javaMultipleFiles: scala.Option[Boolean]
  66. val javaOuterClassname: scala.Option[String]
  67. val javaPackage: scala.Option[String]
  68. val javaStringCheckUtf8: scala.Option[Boolean]
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. val objcClassPrefix: scala.Option[String]
  73. val optimizeFor: scala.Option[OptimizeMode]
  74. val phpClassPrefix: scala.Option[String]
  75. val phpMetadataNamespace: scala.Option[String]
  76. val phpNamespace: scala.Option[String]
  77. val pyGenericServices: scala.Option[Boolean]
  78. val rubyPackage: scala.Option[String]
  79. def serializedSize: Int
    Definition Classes
    FileOptions → GeneratedMessage
  80. val swiftPrefix: scala.Option[String]
  81. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  82. final def toByteArray: Array[Byte]

    Serializes the message and returns a byte array containing its raw bytes

    Serializes the message and returns a byte array containing its raw bytes

    Definition Classes
    GeneratedMessage
  83. final def toByteString: ByteString

    Serializes the message and returns a ByteString containing its raw bytes

    Serializes the message and returns a ByteString containing its raw bytes

    Definition Classes
    GeneratedMessage
  84. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  85. def toProtoString: String

    Returns a human-readable ASCII format representation of this message.

    Returns a human-readable ASCII format representation of this message.

    The original message can be decoded from this format by using fromAscii on the companion object.

    returns

    human-readable representation of this message.

    Definition Classes
    FileOptions → GeneratedMessage
  86. val uninterpretedOption: Seq[UninterpretedOption]
  87. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    FileOptions → ExtendableMessage
  88. def update(ms: (Lens[FileOptions, FileOptions]) ⇒ Mutation[FileOptions]*): FileOptions
    Definition Classes
    Updatable
  89. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  91. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  92. def withCcEnableArenas(__v: Boolean): FileOptions
  93. def withCcGenericServices(__v: Boolean): FileOptions
  94. def withCsharpNamespace(__v: String): FileOptions
  95. def withDeprecated(__v: Boolean): FileOptions
  96. def withExtension[T](generatedExtension: GeneratedExtension[FileOptions, T])(value: T): FileOptions
    Definition Classes
    ExtendableMessage
  97. def withFeatures(__v: FeatureSet): FileOptions
  98. def withGoPackage(__v: String): FileOptions
  99. def withJavaGenerateEqualsAndHash(__v: Boolean): FileOptions
  100. def withJavaGenericServices(__v: Boolean): FileOptions
  101. def withJavaMultipleFiles(__v: Boolean): FileOptions
  102. def withJavaOuterClassname(__v: String): FileOptions
  103. def withJavaPackage(__v: String): FileOptions
  104. def withJavaStringCheckUtf8(__v: Boolean): FileOptions
  105. def withObjcClassPrefix(__v: String): FileOptions
  106. def withOptimizeFor(__v: OptimizeMode): FileOptions
  107. def withPhpClassPrefix(__v: String): FileOptions
  108. def withPhpMetadataNamespace(__v: String): FileOptions
  109. def withPhpNamespace(__v: String): FileOptions
  110. def withPyGenericServices(__v: Boolean): FileOptions
  111. def withRubyPackage(__v: String): FileOptions
  112. def withSwiftPrefix(__v: String): FileOptions
  113. def withUninterpretedOption(__v: Seq[UninterpretedOption]): FileOptions
  114. def withUnknownFields(__v: scalapb.UnknownFieldSet): FileOptions
    Definition Classes
    FileOptions → ExtendableMessage
  115. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  116. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

    Definition Classes
    FileOptions → GeneratedMessage
  117. final def writeTo(output: OutputStream): Unit

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val javaGenerateEqualsAndHash: scala.Option[Boolean]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from ExtendableMessage[FileOptions]

Inherited from Updatable[FileOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped