final case class FileOptions(javaPackage: scala.Option[String] = None, javaOuterClassname: scala.Option[String] = None, javaMultipleFiles: scala.Option[Boolean] = None, javaGenerateEqualsAndHash: scala.Option[Boolean] = None, javaStringCheckUtf8: scala.Option[Boolean] = None, optimizeFor: scala.Option[OptimizeMode] = None, goPackage: scala.Option[String] = None, ccGenericServices: scala.Option[Boolean] = None, javaGenericServices: scala.Option[Boolean] = None, pyGenericServices: scala.Option[Boolean] = None, deprecated: scala.Option[Boolean] = None, ccEnableArenas: scala.Option[Boolean] = None, objcClassPrefix: scala.Option[String] = None, csharpNamespace: scala.Option[String] = None, swiftPrefix: scala.Option[String] = None, phpClassPrefix: scala.Option[String] = None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.collection.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet()) extends scalapb.GeneratedMessage with scalapb.Message[FileOptions] 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

If set, all the classes from the .proto file are wrapped in a single outer class with the given name. This applies to both Proto1 (equivalent to the old "--one_java_file" option) and Proto2 (where a .proto always translates to a single class, but you may want to explicitly choose the class name).

javaMultipleFiles

If set true, 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 outer class named by java_outer_classname. However, the outer 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

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.

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.

uninterpretedOption

The parser stores options it doesn't recognize here. See above.

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

Instance Constructors

  1. new FileOptions(javaPackage: scala.Option[String] = None, javaOuterClassname: scala.Option[String] = None, javaMultipleFiles: scala.Option[Boolean] = None, javaGenerateEqualsAndHash: scala.Option[Boolean] = None, javaStringCheckUtf8: scala.Option[Boolean] = None, optimizeFor: scala.Option[OptimizeMode] = None, goPackage: scala.Option[String] = None, ccGenericServices: scala.Option[Boolean] = None, javaGenericServices: scala.Option[Boolean] = None, pyGenericServices: scala.Option[Boolean] = None, deprecated: scala.Option[Boolean] = None, ccEnableArenas: scala.Option[Boolean] = None, objcClassPrefix: scala.Option[String] = None, csharpNamespace: scala.Option[String] = None, swiftPrefix: scala.Option[String] = None, phpClassPrefix: scala.Option[String] = None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.collection.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.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

    If set, all the classes from the .proto file are wrapped in a single outer class with the given name. This applies to both Proto1 (equivalent to the old "--one_java_file" option) and Proto2 (where a .proto always translates to a single class, but you may want to explicitly choose the class name).

    javaMultipleFiles

    If set true, 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 outer class named by java_outer_classname. However, the outer 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

    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.

    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.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See 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: TraversableOnce[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 clearGoPackage: FileOptions
  14. def clearJavaGenerateEqualsAndHash: FileOptions
  15. def clearJavaGenericServices: FileOptions
  16. def clearJavaMultipleFiles: FileOptions
  17. def clearJavaOuterClassname: FileOptions
  18. def clearJavaPackage: FileOptions
  19. def clearJavaStringCheckUtf8: FileOptions
  20. def clearObjcClassPrefix: FileOptions
  21. def clearOptimizeFor: FileOptions
  22. def clearPhpClassPrefix: FileOptions
  23. def clearPyGenericServices: FileOptions
  24. def clearSwiftPrefix: FileOptions
  25. def clearUninterpretedOption: FileOptions
  26. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def companion: FileOptions.type
    Definition Classes
    FileOptions → GeneratedMessage
  28. val csharpNamespace: scala.Option[String]
  29. val deprecated: scala.Option[Boolean]
  30. def discardUnknownFields: FileOptions
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T
    Definition Classes
    ExtendableMessage
  33. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  34. def getCcEnableArenas: Boolean
  35. def getCcGenericServices: Boolean
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  37. def getCsharpNamespace: String
  38. def getDeprecated: Boolean
  39. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FileOptions → GeneratedMessage
  40. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    FileOptions → GeneratedMessage
  41. def getGoPackage: String
  42. def getJavaGenerateEqualsAndHash: Boolean
  43. def getJavaGenericServices: Boolean
  44. def getJavaMultipleFiles: Boolean
  45. def getJavaOuterClassname: String
  46. def getJavaPackage: String
  47. def getJavaStringCheckUtf8: Boolean
  48. def getObjcClassPrefix: String
  49. def getOptimizeFor: OptimizeMode
  50. def getPhpClassPrefix: String
  51. def getPyGenericServices: Boolean
  52. def getSwiftPrefix: String
  53. val goPackage: scala.Option[String]
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. val javaGenerateEqualsAndHash: scala.Option[Boolean]
  56. val javaGenericServices: scala.Option[Boolean]
  57. val javaMultipleFiles: scala.Option[Boolean]
  58. val javaOuterClassname: scala.Option[String]
  59. val javaPackage: scala.Option[String]
  60. val javaStringCheckUtf8: scala.Option[Boolean]
  61. def mergeFrom(_input__: CodedInputStream): FileOptions
    Definition Classes
    FileOptions → Message
  62. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  63. final def notify(): Unit
    Definition Classes
    AnyRef
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  65. val objcClassPrefix: scala.Option[String]
  66. val optimizeFor: scala.Option[OptimizeMode]
  67. val phpClassPrefix: scala.Option[String]
  68. val pyGenericServices: scala.Option[Boolean]
  69. final def serializedSize: Int
    Definition Classes
    FileOptions → GeneratedMessage
  70. val swiftPrefix: scala.Option[String]
  71. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  72. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  73. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  74. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  75. def toString(): String
    Definition Classes
    FileOptions → AnyRef → Any
  76. val uninterpretedOption: Seq[UninterpretedOption]
  77. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    FileOptions → ExtendableMessage
  78. def update(ms: (Lens[FileOptions, FileOptions]) ⇒ Mutation[FileOptions]*): FileOptions
    Definition Classes
    Updatable
  79. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. def withCcEnableArenas(__v: Boolean): FileOptions
  83. def withCcGenericServices(__v: Boolean): FileOptions
  84. def withCsharpNamespace(__v: String): FileOptions
  85. def withDeprecated(__v: Boolean): FileOptions
  86. def withExtension[T](generatedExtension: GeneratedExtension[FileOptions, T])(value: T): FileOptions
    Definition Classes
    ExtendableMessage
  87. def withGoPackage(__v: String): FileOptions
  88. def withJavaGenerateEqualsAndHash(__v: Boolean): FileOptions
  89. def withJavaGenericServices(__v: Boolean): FileOptions
  90. def withJavaMultipleFiles(__v: Boolean): FileOptions
  91. def withJavaOuterClassname(__v: String): FileOptions
  92. def withJavaPackage(__v: String): FileOptions
  93. def withJavaStringCheckUtf8(__v: Boolean): FileOptions
  94. def withObjcClassPrefix(__v: String): FileOptions
  95. def withOptimizeFor(__v: OptimizeMode): FileOptions
  96. def withPhpClassPrefix(__v: String): FileOptions
  97. def withPyGenericServices(__v: Boolean): FileOptions
  98. def withSwiftPrefix(__v: String): FileOptions
  99. def withUninterpretedOption(__v: Seq[UninterpretedOption]): FileOptions
  100. def withUnknownFields(__v: scalapb.UnknownFieldSet): FileOptions
    Definition Classes
    FileOptions → ExtendableMessage
  101. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  102. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    FileOptions → GeneratedMessage
  103. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, scala.Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): scala.Any
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from ExtendableMessage[FileOptions]

Inherited from Updatable[FileOptions]

Inherited from scalapb.Message[FileOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped