FieldOptions
class FieldOptions extends Message (View source)
Generated from protobuf message google.protobuf.FieldOptions
Properties
| protected | $ctype | NOTE: ctype is deprecated. Use |
|
| protected | $packed | The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire. Rather than repeatedly
writing the tag and type for each element, the entire array is encoded as
a single length-delimited blob. In proto3, only explicit setting it to
false will avoid using packed encoding. This option is prohibited in
Editions, but the |
|
| protected | $jstype | The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. |
|
| protected | $lazy | Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. |
|
| protected | $unverified_lazy | unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons. |
|
| protected | $deprecated | Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields. |
|
| protected deprecated | $weak | DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use. |
|
| protected | $debug_redact | Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials. |
|
| protected | $retention | Generated from protobuf field |
|
| protected | $features | Any features defined in the specific edition. |
|
| protected | $feature_support | Generated from protobuf field |
Methods
Constructor.
Merges the contents of the specified message into current message.
Parses a json string to protobuf message.
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead.
No description
No description
NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead.
The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire. Rather than repeatedly
writing the tag and type for each element, the entire array is encoded as
a single length-delimited blob. In proto3, only explicit setting it to
false will avoid using packed encoding. This option is prohibited in
Editions, but the repeated_field_encoding feature can be used to control
the behavior.
No description
No description
The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire. Rather than repeatedly
writing the tag and type for each element, the entire array is encoded as
a single length-delimited blob. In proto3, only explicit setting it to
false will avoid using packed encoding. This option is prohibited in
Editions, but the repeated_field_encoding feature can be used to control
the behavior.
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript.
No description
No description
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript.
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
No description
No description
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
No description
No description
unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
No description
No description
Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
No description
No description
DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use.
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
No description
No description
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
Generated from protobuf field optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
No description
No description
Generated from protobuf field optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
Generated from protobuf field repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
Generated from protobuf field repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
Generated from protobuf field repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
Generated from protobuf field repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
Any features defined in the specific edition.
No description
No description
Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
No description
No description
Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
The parser stores options it doesn't recognize here. See above.
The parser stores options it doesn't recognize here. See above.
Details
__construct($data = NULL)
Constructor.
protected
readWrapperValue($member)
No description
protected
writeWrapperValue($member, $value)
No description
protected
readOneof($number)
No description
protected
hasOneof($number)
No description
protected
writeOneof($number, $value)
No description
protected
whichOneof($oneof_name)
No description
null
clear()
Clear all containing fields.
null
discardUnknownFields()
Clear all unknown fields previously parsed.
null
mergeFrom(object $msg)
Merges the contents of the specified message into current message.
This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.
null
mergeFromString(string $data)
Parses a protocol buffer contained in a string.
This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.
null
mergeFromJsonString(string $data, bool $ignore_unknown = false)
Parses a json string to protobuf message.
This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.
parseFromStream($input)
No description
protected null
mergeFromArray(array $array)
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
Example:
$message->mergeFromArray([
'name' => 'This is a message name',
'interval' => [
'startTime' => time() - 60,
'endTime' => time(),
]
]);This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.
protected
mergeFromJsonArray($array, $ignore_unknown)
No description
parseFromJsonStream($input, $ignore_unknown)
No description
serializeToStream($output)
No description
serializeToJsonStream($output)
No description
string
serializeToString()
Serialize the message to string.
string
serializeToJsonString($options = 0)
Serialize the message to json string.
byteSize()
No description
jsonByteSize($options = 0)
No description
__debugInfo()
No description
int
getCtype()
NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead.
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
Generated from protobuf field optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
hasCtype()
No description
clearCtype()
No description
$this
setCtype(int $var)
NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead.
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
Generated from protobuf field optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
bool
getPacked()
The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire. Rather than repeatedly
writing the tag and type for each element, the entire array is encoded as
a single length-delimited blob. In proto3, only explicit setting it to
false will avoid using packed encoding. This option is prohibited in
Editions, but the repeated_field_encoding feature can be used to control
the behavior.
Generated from protobuf field optional bool packed = 2;
hasPacked()
No description
clearPacked()
No description
$this
setPacked(bool $var)
The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire. Rather than repeatedly
writing the tag and type for each element, the entire array is encoded as
a single length-delimited blob. In proto3, only explicit setting it to
false will avoid using packed encoding. This option is prohibited in
Editions, but the repeated_field_encoding feature can be used to control
the behavior.
Generated from protobuf field optional bool packed = 2;
int
getJstype()
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript.
Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.
Generated from protobuf field optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
hasJstype()
No description
clearJstype()
No description
$this
setJstype(int $var)
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript.
Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.
Generated from protobuf field optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
bool
getLazy()
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).
Generated from protobuf field optional bool lazy = 5 [default = false];
hasLazy()
No description
clearLazy()
No description
$this
setLazy(bool $var)
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).
Generated from protobuf field optional bool lazy = 5 [default = false];
bool
getUnverifiedLazy()
unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
Generated from protobuf field optional bool unverified_lazy = 15 [default = false];
hasUnverifiedLazy()
No description
clearUnverifiedLazy()
No description
$this
setUnverifiedLazy(bool $var)
unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
Generated from protobuf field optional bool unverified_lazy = 15 [default = false];
bool
getDeprecated()
Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
Generated from protobuf field optional bool deprecated = 3 [default = false];
hasDeprecated()
No description
clearDeprecated()
No description
$this
setDeprecated(bool $var)
Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
Generated from protobuf field optional bool deprecated = 3 [default = false];
bool
getWeak()
deprecated
deprecated
DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use.
Generated from protobuf field optional bool weak = 10 [default = false, deprecated = true];
hasWeak()
No description
clearWeak()
No description
$this
setWeak(bool $var)
deprecated
deprecated
DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use.
Generated from protobuf field optional bool weak = 10 [default = false, deprecated = true];
bool
getDebugRedact()
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
Generated from protobuf field optional bool debug_redact = 16 [default = false];
hasDebugRedact()
No description
clearDebugRedact()
No description
$this
setDebugRedact(bool $var)
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
Generated from protobuf field optional bool debug_redact = 16 [default = false];
int
getRetention()
Generated from protobuf field optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
hasRetention()
No description
clearRetention()
No description
$this
setRetention(int $var)
Generated from protobuf field optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
RepeatedField<int>
getTargets()
Generated from protobuf field repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
$this
setTargets(int[] $var)
Generated from protobuf field repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
EditionDefault>
getEditionDefaults()
Generated from protobuf field repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
$this
setEditionDefaults(EditionDefault[] $var)
Generated from protobuf field repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
FeatureSet|null
getFeatures()
Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
Generated from protobuf field optional .google.protobuf.FeatureSet features = 21;
hasFeatures()
No description
clearFeatures()
No description
$this
setFeatures(FeatureSet $var)
Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
Generated from protobuf field optional .google.protobuf.FeatureSet features = 21;
FeatureSupport|null
getFeatureSupport()
Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
hasFeatureSupport()
No description
clearFeatureSupport()
No description
$this
setFeatureSupport(FeatureSupport $var)
Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
UninterpretedOption>
getUninterpretedOption()
The parser stores options it doesn't recognize here. See above.
Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
$this
setUninterpretedOption(UninterpretedOption[] $var)
The parser stores options it doesn't recognize here. See above.
Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;