Class DescriptorProtos.FileOptions.Builder (3.19.4)

Protobuf type google.protobuf.FileOptions

Append a value to a repeated extension.

Clear an extension.

Set the value of an extension.

Set the value of one element of a repeated extension.

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

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

optional bool cc_enable_arenas = 31 [default = true];

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.

optional bool cc_generic_services = 16 [default = false];

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

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.

optional bool deprecated = 23 [default = false];

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.

optional string go_package = 11;

This option does nothing.

optional bool java_generate_equals_and_hash = 20 [deprecated = true];

optional bool java_generic_services = 17 [default = false];

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.

optional bool java_multiple_files = 10 [default = false];

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.

optional string java_outer_classname = 8;

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.

optional string java_package = 1;

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.

optional bool java_string_check_utf8 = 27 [default = false];

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

optional string objc_class_prefix = 36;

TODO(jieluo): Clear it when all subclasses have implemented this method.

optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

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

optional string php_class_prefix = 40;

optional bool php_generic_services = 42 [default = false];

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.

optional string php_metadata_namespace = 44;

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.

optional string php_namespace = 41;

optional bool py_generic_services = 18 [default = false];

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.

optional string ruby_package = 45;

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.

optional string swift_prefix = 39;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Clones the Builder.

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

optional bool cc_enable_arenas = 31 [default = true];

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.

optional bool cc_generic_services = 16 [default = false];

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

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.

optional bool deprecated = 23 [default = false];

Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.

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.

optional string go_package = 11;

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.

optional string go_package = 11;

This option does nothing.

optional bool java_generate_equals_and_hash = 20 [deprecated = true];

optional bool java_generic_services = 17 [default = false];

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.

optional bool java_multiple_files = 10 [default = false];

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.

optional string java_outer_classname = 8;

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.

optional string java_outer_classname = 8;

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.

optional string java_package = 1;

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.

optional string java_package = 1;

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.

optional bool java_string_check_utf8 = 27 [default = false];

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

optional string objc_class_prefix = 36;

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

optional string objc_class_prefix = 36;

optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

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

optional string php_class_prefix = 40;

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

optional string php_class_prefix = 40;

optional bool php_generic_services = 42 [default = false];

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.

optional string php_metadata_namespace = 44;

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.

optional string php_metadata_namespace = 44;

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.

optional string php_namespace = 41;

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.

optional string php_namespace = 41;

optional bool py_generic_services = 18 [default = false];

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.

optional string ruby_package = 45;

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.

optional string ruby_package = 45;

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.

optional string swift_prefix = 39;

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.

optional string swift_prefix = 39;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

optional bool cc_enable_arenas = 31 [default = true];

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.

optional bool cc_generic_services = 16 [default = false];

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

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.

optional bool deprecated = 23 [default = false];

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.

optional string go_package = 11;

This option does nothing.

optional bool java_generate_equals_and_hash = 20 [deprecated = true];

optional bool java_generic_services = 17 [default = false];

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.

optional bool java_multiple_files = 10 [default = false];

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.

optional string java_outer_classname = 8;

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.

optional string java_package = 1;

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.

optional bool java_string_check_utf8 = 27 [default = false];

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

optional string objc_class_prefix = 36;

optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

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

optional string php_class_prefix = 40;

optional bool php_generic_services = 42 [default = false];

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.

optional string php_metadata_namespace = 44;

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.

optional string php_namespace = 41;

optional bool py_generic_services = 18 [default = false];

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.

optional string ruby_package = 45;

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.

optional string swift_prefix = 39;

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Like Builder#mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

Merging occurs as follows. For each field:

• For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
  
• For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
  
• For repeated fields, the elements in other are concatenated with the elements in this message.
  

• For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

  This is equivalent to the Message::MergeFrom method in C++.

Merge some unknown fields into the UnknownFieldSet for this message.

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

optional bool cc_enable_arenas = 31 [default = true];

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.

optional bool cc_generic_services = 16 [default = false];

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

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.

optional bool deprecated = 23 [default = false];

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.

optional string go_package = 11;

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.

optional string go_package = 11;

This option does nothing.

optional bool java_generate_equals_and_hash = 20 [deprecated = true];

optional bool java_generic_services = 17 [default = false];

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.

optional bool java_multiple_files = 10 [default = false];

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.

optional string java_outer_classname = 8;

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.

optional string java_outer_classname = 8;

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.

optional string java_package = 1;

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.

optional string java_package = 1;

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.

optional bool java_string_check_utf8 = 27 [default = false];

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

optional string objc_class_prefix = 36;

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

optional string objc_class_prefix = 36;

optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

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

optional string php_class_prefix = 40;

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

optional string php_class_prefix = 40;

optional bool php_generic_services = 42 [default = false];

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.

optional string php_metadata_namespace = 44;

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.

optional string php_metadata_namespace = 44;

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.

optional string php_namespace = 41;

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.

optional string php_namespace = 41;

optional bool py_generic_services = 18 [default = false];

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.

optional string ruby_package = 45;

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.

optional string ruby_package = 45;

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.

optional string swift_prefix = 39;

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.

optional string swift_prefix = 39;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;