Package 

Class FileOptionsKt.Dsl

    • Method Detail

      • getOptimizeFor

         final DescriptorProtos.FileOptions.OptimizeMode getOptimizeFor()
      • setOptimizeFor

         final Unit setOptimizeFor(DescriptorProtos.FileOptions.OptimizeMode optimizeFor)
      • clearJavaPackage

         final Unit clearJavaPackage()
        <pre> 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. </pre>

        <code>optional string java_package = 1;</code>

      • hasJavaPackage

         final Boolean hasJavaPackage()
        <pre> 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. </pre>

        <code>optional string java_package = 1;</code>

      • clearJavaOuterClassname

         final Unit clearJavaOuterClassname()
        <pre> 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. </pre>

        <code>optional string java_outer_classname = 8;</code>

      • hasJavaOuterClassname

         final Boolean hasJavaOuterClassname()
        <pre> 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. </pre>

        <code>optional string java_outer_classname = 8;</code>

      • clearJavaMultipleFiles

         final Unit clearJavaMultipleFiles()
        <pre> 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. </pre>

        <code>optional bool java_multiple_files = 10 default = false;</code>

      • hasJavaMultipleFiles

         final Boolean hasJavaMultipleFiles()
        <pre> 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. </pre>

        <code>optional bool java_multiple_files = 10 default = false;</code>

      • clearJavaGenerateEqualsAndHash

         final Unit clearJavaGenerateEqualsAndHash()
        <pre> This option does nothing. </pre>

        <code>optional bool java_generate_equals_and_hash = 20 deprecated = true;</code>

      • hasJavaGenerateEqualsAndHash

         final Boolean hasJavaGenerateEqualsAndHash()
        <pre> This option does nothing. </pre>

        <code>optional bool java_generate_equals_and_hash = 20 deprecated = true;</code>

      • clearJavaStringCheckUtf8

         final Unit clearJavaStringCheckUtf8()
        <pre> 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. </pre>

        <code>optional bool java_string_check_utf8 = 27 default = false;</code>

      • hasJavaStringCheckUtf8

         final Boolean hasJavaStringCheckUtf8()
        <pre> 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. </pre>

        <code>optional bool java_string_check_utf8 = 27 default = false;</code>

      • clearOptimizeFor

         final Unit clearOptimizeFor()

        <code>optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 default = SPEED;</code>

      • hasOptimizeFor

         final Boolean hasOptimizeFor()

        <code>optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 default = SPEED;</code>

      • clearGoPackage

         final Unit clearGoPackage()
        <pre> 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. </pre>

        <code>optional string go_package = 11;</code>

      • hasGoPackage

         final Boolean hasGoPackage()
        <pre> 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. </pre>

        <code>optional string go_package = 11;</code>

      • clearCcGenericServices

         final Unit clearCcGenericServices()
        <pre> 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. </pre>

        <code>optional bool cc_generic_services = 16 default = false;</code>

      • hasCcGenericServices

         final Boolean hasCcGenericServices()
        <pre> 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. </pre>

        <code>optional bool cc_generic_services = 16 default = false;</code>

      • clearDeprecated

         final Unit clearDeprecated()
        <pre> 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. </pre>

        <code>optional bool deprecated = 23 default = false;</code>

      • hasDeprecated

         final Boolean hasDeprecated()
        <pre> 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. </pre>

        <code>optional bool deprecated = 23 default = false;</code>

      • clearCcEnableArenas

         final Unit clearCcEnableArenas()
        <pre> Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. </pre>

        <code>optional bool cc_enable_arenas = 31 default = true;</code>

      • hasCcEnableArenas

         final Boolean hasCcEnableArenas()
        <pre> Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. </pre>

        <code>optional bool cc_enable_arenas = 31 default = true;</code>

      • clearObjcClassPrefix

         final Unit clearObjcClassPrefix()
        <pre> Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. </pre>

        <code>optional string objc_class_prefix = 36;</code>

      • hasObjcClassPrefix

         final Boolean hasObjcClassPrefix()
        <pre> Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. </pre>

        <code>optional string objc_class_prefix = 36;</code>

      • clearCsharpNamespace

         final Unit clearCsharpNamespace()
        <pre> Namespace for generated classes; defaults to the package. </pre>

        <code>optional string csharp_namespace = 37;</code>

      • hasCsharpNamespace

         final Boolean hasCsharpNamespace()
        <pre> Namespace for generated classes; defaults to the package. </pre>

        <code>optional string csharp_namespace = 37;</code>

      • clearSwiftPrefix

         final Unit clearSwiftPrefix()
        <pre> 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. </pre>

        <code>optional string swift_prefix = 39;</code>

      • hasSwiftPrefix

         final Boolean hasSwiftPrefix()
        <pre> 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. </pre>

        <code>optional string swift_prefix = 39;</code>

      • clearPhpClassPrefix

         final Unit clearPhpClassPrefix()
        <pre> Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. </pre>

        <code>optional string php_class_prefix = 40;</code>

      • hasPhpClassPrefix

         final Boolean hasPhpClassPrefix()
        <pre> Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. </pre>

        <code>optional string php_class_prefix = 40;</code>

      • clearPhpNamespace

         final Unit clearPhpNamespace()
        <pre> 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. </pre>

        <code>optional string php_namespace = 41;</code>

      • hasPhpNamespace

         final Boolean hasPhpNamespace()
        <pre> 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. </pre>

        <code>optional string php_namespace = 41;</code>

      • clearPhpMetadataNamespace

         final Unit clearPhpMetadataNamespace()
        <pre> 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. </pre>

        <code>optional string php_metadata_namespace = 44;</code>

      • hasPhpMetadataNamespace

         final Boolean hasPhpMetadataNamespace()
        <pre> 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. </pre>

        <code>optional string php_metadata_namespace = 44;</code>

      • clearRubyPackage

         final Unit clearRubyPackage()
        <pre> 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. </pre>

        <code>optional string ruby_package = 45;</code>

      • hasRubyPackage

         final Boolean hasRubyPackage()
        <pre> 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. </pre>

        <code>optional string ruby_package = 45;</code>