FileOptions

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.

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.

uninterpretedOption

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

Annotations: @SerialVersionUID()

Linear Supertypes

Product, Equals, ExtendableMessage[FileOptions], Updatable[FileOptions], scalapb.Message[FileOptions], scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

new FileOptions(javaPackage: Option[String] = _root_.scala.None, javaOuterClassname: Option[String] = _root_.scala.None, javaMultipleFiles: Option[Boolean] = _root_.scala.None, javaGenerateEqualsAndHash: Option[Boolean] = _root_.scala.None, javaStringCheckUtf8: Option[Boolean] = _root_.scala.None, optimizeFor: Option[OptimizeMode] = _root_.scala.None, goPackage: Option[String] = _root_.scala.None, ccGenericServices: Option[Boolean] = _root_.scala.None, javaGenericServices: Option[Boolean] = _root_.scala.None, pyGenericServices: Option[Boolean] = _root_.scala.None, phpGenericServices: Option[Boolean] = _root_.scala.None, deprecated: Option[Boolean] = _root_.scala.None, ccEnableArenas: Option[Boolean] = _root_.scala.None, objcClassPrefix: Option[String] = _root_.scala.None, csharpNamespace: Option[String] = _root_.scala.None, swiftPrefix: Option[String] = _root_.scala.None, phpClassPrefix: Option[String] = _root_.scala.None, phpNamespace: Option[String] = _root_.scala.None, phpMetadataNamespace: Option[String] = _root_.scala.None, rubyPackage: Option[String] = _root_.scala.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.
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.
uninterpretedOption
The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): FileOptions
def addUninterpretedOption(__vs: UninterpretedOption*): FileOptions
final def asInstanceOf[T0]: T0

Definition Classes
Any
val ccEnableArenas: Option[Boolean]

Enables the use of arenas for the proto messages in this file.
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.
val ccGenericServices: Option[Boolean]

Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system.
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.
def clearCcEnableArenas: FileOptions
def clearCcGenericServices: FileOptions
def clearCsharpNamespace: FileOptions
def clearDeprecated: FileOptions
def clearGoPackage: FileOptions
def clearJavaGenerateEqualsAndHash: FileOptions
def clearJavaGenericServices: FileOptions
def clearJavaMultipleFiles: FileOptions
def clearJavaOuterClassname: FileOptions
def clearJavaPackage: FileOptions
def clearJavaStringCheckUtf8: FileOptions
def clearObjcClassPrefix: FileOptions
def clearOptimizeFor: FileOptions
def clearPhpClassPrefix: FileOptions
def clearPhpGenericServices: FileOptions
def clearPhpMetadataNamespace: FileOptions
def clearPhpNamespace: FileOptions
def clearPyGenericServices: FileOptions
def clearRubyPackage: FileOptions
def clearSwiftPrefix: FileOptions
def clearUninterpretedOption: FileOptions
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def companion: FileOptions.type

Definition Classes
FileOptions → GeneratedMessage
val csharpNamespace: Option[String]

Namespace for generated classes; defaults to the package.
val deprecated: Option[Boolean]

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.
def discardUnknownFields: FileOptions
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T

Definition Classes
ExtendableMessage
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getCcEnableArenas: Boolean
def getCcGenericServices: Boolean
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getCsharpNamespace: String
def getDeprecated: Boolean
def getField(__field: FieldDescriptor): PValue

Definition Classes
FileOptions → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

Definition Classes
FileOptions → GeneratedMessage
def getGoPackage: String
def getJavaGenerateEqualsAndHash: Boolean
def getJavaGenericServices: Boolean
def getJavaMultipleFiles: Boolean
def getJavaOuterClassname: String
def getJavaPackage: String
def getJavaStringCheckUtf8: Boolean
def getObjcClassPrefix: String
def getOptimizeFor: OptimizeMode
def getPhpClassPrefix: String
def getPhpGenericServices: Boolean
def getPhpMetadataNamespace: String
def getPhpNamespace: String
def getPyGenericServices: Boolean
def getRubyPackage: String
def getSwiftPrefix: String
val goPackage: Option[String]

Sets the Go package where structs generated from this .proto will be placed.
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.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val javaGenericServices: Option[Boolean]
val javaMultipleFiles: Option[Boolean]

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.
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.
val javaOuterClassname: Option[String]

If set, all the classes from the .proto file are wrapped in a single outer class with the given name.
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).
val javaPackage: Option[String]

Sets the Java package where classes generated from this .proto will be placed.
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.
val javaStringCheckUtf8: Option[Boolean]

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.
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.
def mergeFrom(_input__: CodedInputStream): FileOptions

Definition Classes
FileOptions → Message
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val objcClassPrefix: Option[String]

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto.
Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.
val optimizeFor: Option[OptimizeMode]
val phpClassPrefix: Option[String]

Sets the php class prefix which is prepended to all php generated classes from this .proto.
Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.
val phpGenericServices: Option[Boolean]
val phpMetadataNamespace: Option[String]

Use this option to change the namespace of php generated metadata classes.
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.
val phpNamespace: Option[String]

Use this option to change the namespace of php generated classes.
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.
val pyGenericServices: Option[Boolean]
val rubyPackage: Option[String]

Use this option to change the package of ruby generated classes.
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.
final def serializedSize: Int

Definition Classes
FileOptions → GeneratedMessage
val swiftPrefix: Option[String]

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined.
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
def toPMessage: PMessage

Definition Classes
GeneratedMessage
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
val uninterpretedOption: Seq[UninterpretedOption]

The parser stores options it doesn't recognize here.
The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.
val unknownFields: scalapb.UnknownFieldSet

Definition Classes
FileOptions → ExtendableMessage
def update(ms: (Lens[FileOptions, FileOptions]) ⇒ Mutation[FileOptions]*): FileOptions

Definition Classes
Updatable
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withCcEnableArenas(__v: Boolean): FileOptions
def withCcGenericServices(__v: Boolean): FileOptions
def withCsharpNamespace(__v: String): FileOptions
def withDeprecated(__v: Boolean): FileOptions
def withExtension[T](generatedExtension: GeneratedExtension[FileOptions, T])(value: T): FileOptions

Definition Classes
ExtendableMessage
def withGoPackage(__v: String): FileOptions
def withJavaGenerateEqualsAndHash(__v: Boolean): FileOptions
def withJavaGenericServices(__v: Boolean): FileOptions
def withJavaMultipleFiles(__v: Boolean): FileOptions
def withJavaOuterClassname(__v: String): FileOptions
def withJavaPackage(__v: String): FileOptions
def withJavaStringCheckUtf8(__v: Boolean): FileOptions
def withObjcClassPrefix(__v: String): FileOptions
def withOptimizeFor(__v: OptimizeMode): FileOptions
def withPhpClassPrefix(__v: String): FileOptions
def withPhpGenericServices(__v: Boolean): FileOptions
def withPhpMetadataNamespace(__v: String): FileOptions
def withPhpNamespace(__v: String): FileOptions
def withPyGenericServices(__v: Boolean): FileOptions
def withRubyPackage(__v: String): FileOptions
def withSwiftPrefix(__v: String): FileOptions
def withUninterpretedOption(__v: Seq[UninterpretedOption]): FileOptions
def withUnknownFields(__v: scalapb.UnknownFieldSet): FileOptions

Definition Classes
FileOptions → ExtendableMessage
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

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

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
def getField(field: FieldDescriptor): Any

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue
val javaGenerateEqualsAndHash: Option[Boolean]

This option does nothing.
This option does nothing.

Annotations
@deprecated
Deprecated
(Since version ) Marked as deprecated in proto file

Related Docs: object FileOptions | package descriptor

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): FileOptions

def addUninterpretedOption(__vs: UninterpretedOption*): FileOptions

final def asInstanceOf[T0]: T0

val ccEnableArenas: Option[Boolean]

val ccGenericServices: Option[Boolean]

def clearCcEnableArenas: FileOptions

def clearCcGenericServices: FileOptions

def clearCsharpNamespace: FileOptions

def clearDeprecated: FileOptions

def clearGoPackage: FileOptions

def clearJavaGenerateEqualsAndHash: FileOptions

def clearJavaGenericServices: FileOptions

def clearJavaMultipleFiles: FileOptions

def clearJavaOuterClassname: FileOptions

def clearJavaPackage: FileOptions

def clearJavaStringCheckUtf8: FileOptions

def clearObjcClassPrefix: FileOptions

def clearOptimizeFor: FileOptions

def clearPhpClassPrefix: FileOptions

def clearPhpGenericServices: FileOptions

def clearPhpMetadataNamespace: FileOptions

def clearPhpNamespace: FileOptions

def clearPyGenericServices: FileOptions

def clearRubyPackage: FileOptions

def clearSwiftPrefix: FileOptions

def clearUninterpretedOption: FileOptions

def clone(): AnyRef

def companion: FileOptions.type

val csharpNamespace: Option[String]

val deprecated: Option[Boolean]

def discardUnknownFields: FileOptions

final def eq(arg0: AnyRef): Boolean

def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T

def finalize(): Unit

def getCcEnableArenas: Boolean

def getCcGenericServices: Boolean

final def getClass(): Class[_]

def getCsharpNamespace: String

def getDeprecated: Boolean

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

def getGoPackage: String

def getJavaGenerateEqualsAndHash: Boolean

def getJavaGenericServices: Boolean

def getJavaMultipleFiles: Boolean

def getJavaOuterClassname: String

def getJavaPackage: String

def getJavaStringCheckUtf8: Boolean

def getObjcClassPrefix: String

def getOptimizeFor: OptimizeMode

def getPhpClassPrefix: String

def getPhpGenericServices: Boolean

def getPhpMetadataNamespace: String

def getPhpNamespace: String

def getPyGenericServices: Boolean

def getRubyPackage: String

def getSwiftPrefix: String

val goPackage: Option[String]

final def isInstanceOf[T0]: Boolean

val javaGenericServices: Option[Boolean]

val javaMultipleFiles: Option[Boolean]

val javaOuterClassname: Option[String]

val javaPackage: Option[String]

val javaStringCheckUtf8: Option[Boolean]

def mergeFrom(_input__: CodedInputStream): FileOptions

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val objcClassPrefix: Option[String]

val optimizeFor: Option[OptimizeMode]

val phpClassPrefix: Option[String]

val phpGenericServices: Option[Boolean]

val phpMetadataNamespace: Option[String]