Generated from protobuf message google.protobuf.FileOptions

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getCcEnableArenas()
     
    Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

    Generated from protobuf field optional bool cc_enable_arenas = 31 [default = false];

    • return bool
    public getCcGenericServices()
     
    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.

    Generated from protobuf field optional bool cc_generic_services = 16 [default = false];

    • return bool
    public getCsharpNamespace()
     
    Namespace for generated classes; defaults to the package.

    Generated from protobuf field optional string csharp_namespace = 37;

    • return string
    public getDeprecated()
     
    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.

    Generated from protobuf field optional bool deprecated = 23 [default = false];

    • return bool
    public getGoPackage()
     
    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.

    Generated from protobuf field optional string go_package = 11;

    • return string
    public getJavaGenerateEqualsAndHash()
     
    This option does nothing.

    Generated from protobuf field optional bool java_generate_equals_and_hash = 20 [deprecated = true];

    • return bool
    public getJavaGenericServices()
     
    Generated from protobuf field optional bool java_generic_services = 17 [default = false];

    • return bool
    public getJavaMultipleFiles()
     
    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.

    Generated from protobuf field optional bool java_multiple_files = 10 [default = false];

    • return bool
    public getJavaOuterClassname()
     
    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).

    Generated from protobuf field optional string java_outer_classname = 8;

    • return string
    public getJavaPackage()
     
    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.

    Generated from protobuf field optional string java_package = 1;

    • return string
    public getJavaStringCheckUtf8()
     
    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.

    Generated from protobuf field optional bool java_string_check_utf8 = 27 [default = false];

    • return bool
    public getObjcClassPrefix()
     
    Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

    Generated from protobuf field optional string objc_class_prefix = 36;

    • return string
    public getOptimizeFor()
     
    Generated from protobuf field optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

    • return int
    public getPhpClassPrefix()
     
    Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

    Generated from protobuf field optional string php_class_prefix = 40;

    • return string
    public getPhpGenericServices()
     
    Generated from protobuf field optional bool php_generic_services = 42 [default = false];

    • return bool
    public getPhpMetadataNamespace()
     
    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.

    Generated from protobuf field optional string php_metadata_namespace = 44;

    • return string
    public getPhpNamespace()
     
    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.

    Generated from protobuf field optional string php_namespace = 41;

    • return string
    public getPyGenericServices()
     
    Generated from protobuf field optional bool py_generic_services = 18 [default = false];

    • return bool
    public getRubyPackage()
     
    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.

    Generated from protobuf field optional string ruby_package = 45;

    • return string
    public getSwiftPrefix()
     
    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.

    Generated from protobuf field optional string swift_prefix = 39;

    • return string
    public getUninterpretedOption()
     
    The parser stores options it doesn't recognize here.

    See the documentation for the "Options" section above.

    Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    public hasCcEnableArenas()
    public hasCcGenericServices()
    public hasCsharpNamespace()
    public hasDeprecated()
    public hasGoPackage()
    public hasJavaGenerateEqualsAndHash()
    public hasJavaGenericServices()
    public hasJavaMultipleFiles()
    public hasJavaOuterClassname()
    public hasJavaPackage()
    public hasJavaStringCheckUtf8()
    public hasObjcClassPrefix()
    public hasOptimizeFor()
    public hasPhpClassPrefix()
    public hasPhpGenericServices()
    public hasPhpMetadataNamespace()
    public hasPhpNamespace()
    public hasPyGenericServices()
    public hasRubyPackage()
    public hasSwiftPrefix()
    public hasUninterpretedOption()
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     
    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     
    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setCcEnableArenas( $var)
     
    Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

    Generated from protobuf field optional bool cc_enable_arenas = 31 [default = false];

    • return $this
    public setCcGenericServices( $var)
     
    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.

    Generated from protobuf field optional bool cc_generic_services = 16 [default = false];

    • return $this
    public setCsharpNamespace( $var)
     
    Namespace for generated classes; defaults to the package.

    Generated from protobuf field optional string csharp_namespace = 37;

    • return $this
    public setDeprecated( $var)
     
    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.

    Generated from protobuf field optional bool deprecated = 23 [default = false];

    • return $this
    public setGoPackage( $var)
     
    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.

    Generated from protobuf field optional string go_package = 11;

    • return $this
    public setJavaGenerateEqualsAndHash( $var)
     
    This option does nothing.

    Generated from protobuf field optional bool java_generate_equals_and_hash = 20 [deprecated = true];

    • return $this
    public setJavaGenericServices( $var)
     
    Generated from protobuf field optional bool java_generic_services = 17 [default = false];

    • return $this
    public setJavaMultipleFiles( $var)
     
    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.

    Generated from protobuf field optional bool java_multiple_files = 10 [default = false];

    • return $this
    public setJavaOuterClassname( $var)
     
    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).

    Generated from protobuf field optional string java_outer_classname = 8;

    • return $this
    public setJavaPackage( $var)
     
    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.

    Generated from protobuf field optional string java_package = 1;

    • return $this
    public setJavaStringCheckUtf8( $var)
     
    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.

    Generated from protobuf field optional bool java_string_check_utf8 = 27 [default = false];

    • return $this
    public setObjcClassPrefix( $var)
     
    Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

    Generated from protobuf field optional string objc_class_prefix = 36;

    • return $this
    public setOptimizeFor( $var)
     
    Generated from protobuf field optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

    • return $this
    public setPhpClassPrefix( $var)
     
    Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

    Generated from protobuf field optional string php_class_prefix = 40;

    • return $this
    public setPhpGenericServices( $var)
     
    Generated from protobuf field optional bool php_generic_services = 42 [default = false];

    • return $this
    public setPhpMetadataNamespace( $var)
     
    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.

    Generated from protobuf field optional string php_metadata_namespace = 44;

    • return $this
    public setPhpNamespace( $var)
     
    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.

    Generated from protobuf field optional string php_namespace = 41;

    • return $this
    public setPyGenericServices( $var)
     
    Generated from protobuf field optional bool py_generic_services = 18 [default = false];

    • return $this
    public setRubyPackage( $var)
     
    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.

    Generated from protobuf field optional string ruby_package = 45;

    • return $this
    public setSwiftPrefix( $var)
     
    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.

    Generated from protobuf field optional string swift_prefix = 39;

    • return $this
    public setUninterpretedOption( $var)
     
    The parser stores options it doesn't recognize here.

    See the documentation for the "Options" section above.

    Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • return $this
    Properties
    protected $cc_enable_arenas
     
    Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

    Generated from protobuf field optional bool cc_enable_arenas = 31 [default = false];

    protected $cc_generic_services
     
    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.

    Generated from protobuf field optional bool cc_generic_services = 16 [default = false];

    protected $csharp_namespace
     
    Namespace for generated classes; defaults to the package.

    Generated from protobuf field optional string csharp_namespace = 37;

    protected $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.

    Generated from protobuf field optional bool deprecated = 23 [default = false];

    protected $go_package
     
    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.

    Generated from protobuf field optional string go_package = 11;

    protected $java_generate_equals_and_hash
     
    This option does nothing.

    Generated from protobuf field optional bool java_generate_equals_and_hash = 20 [deprecated = true];

    protected $java_generic_services
     
    Generated from protobuf field optional bool java_generic_services = 17 [default = false];

    protected $java_multiple_files
     
    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.

    Generated from protobuf field optional bool java_multiple_files = 10 [default = false];

    protected $java_outer_classname
     
    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).

    Generated from protobuf field optional string java_outer_classname = 8;

    protected $java_package
     
    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.

    Generated from protobuf field optional string java_package = 1;

    protected $java_string_check_utf8
     
    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.

    Generated from protobuf field optional bool java_string_check_utf8 = 27 [default = false];

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

    Generated from protobuf field optional string objc_class_prefix = 36;

    protected $optimize_for
     
    Generated from protobuf field optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

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

    Generated from protobuf field optional string php_class_prefix = 40;

    protected $php_generic_services
     
    Generated from protobuf field optional bool php_generic_services = 42 [default = false];

    protected $php_metadata_namespace
     
    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.

    Generated from protobuf field optional string php_metadata_namespace = 44;

    protected $php_namespace
     
    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.

    Generated from protobuf field optional string php_namespace = 41;

    protected $py_generic_services
     
    Generated from protobuf field optional bool py_generic_services = 18 [default = false];

    protected $ruby_package
     
    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.

    Generated from protobuf field optional string ruby_package = 45;

    protected $swift_prefix
     
    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.

    Generated from protobuf field optional string swift_prefix = 39;

    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $has_cc_enable_arenas
    private $has_cc_generic_services
    private $has_csharp_namespace
    private $has_deprecated
    private $has_go_package
    private $has_java_generate_equals_and_hash
    private $has_java_generic_services
    private $has_java_multiple_files
    private $has_java_outer_classname
    private $has_java_package
    private $has_java_string_check_utf8
    private $has_objc_class_prefix
    private $has_optimize_for
    private $has_php_class_prefix
    private $has_php_generic_services
    private $has_php_metadata_namespace
    private $has_php_namespace
    private $has_py_generic_services
    private $has_ruby_package
    private $has_swift_prefix
    private $has_uninterpreted_option
    private $uninterpreted_option
     
    The parser stores options it doesn't recognize here.

    See the documentation for the "Options" section above.

    Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     


    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     
    Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       
      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         


        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         


        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         


        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         
        Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           
          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             


            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only