proto library Client - Class EnumValueOptions (v5.36.2)

Reference documentation and code samples for the proto library Client class EnumValueOptions.

Generated from protobuf message google.protobuf.EnumValueOptions

Namespace

Google \ Protobuf \ Internal

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ deprecated	bool Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values.
↳ features	FeatureSet 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.
↳ debug_redact	bool Indicate that fields annotated with this enum value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
↳ feature_support	FieldOptions\FeatureSupport Information about the support window of a feature value.
↳ uninterpreted_option	array<UninterpretedOption> The parser stores options it doesn't recognize here. See above.

getDeprecated

Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values.

Returns
Type	Description
bool

hasDeprecated

clearDeprecated

setDeprecated

Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

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.

Returns
Type	Description
FeatureSet|null

hasFeatures

clearFeatures

setFeatures

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.

Parameter
Name	Description
var	FeatureSet

Returns
Type	Description
$this

getDebugRedact

Indicate that fields annotated with this enum value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

Returns
Type	Description
bool

hasDebugRedact

clearDebugRedact

setDebugRedact

Indicate that fields annotated with this enum value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getFeatureSupport

Information about the support window of a feature value.

Returns
Type	Description
FieldOptions\FeatureSupport|null

hasFeatureSupport

clearFeatureSupport

setFeatureSupport

Information about the support window of a feature value.

Parameter
Name	Description
var	FieldOptions\FeatureSupport

Returns
Type	Description
$this

getUninterpretedOption

The parser stores options it doesn't recognize here. See above.

Returns
Type	Description
Google\Protobuf\RepeatedField<UninterpretedOption>

setUninterpretedOption

The parser stores options it doesn't recognize here. See above.

Parameter
Name	Description
var	array<UninterpretedOption>

Returns
Type	Description
$this