PHPFUI/InstaDoc

Generated from protobuf message google.protobuf.EnumValueOptions

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type bool $deprecated
      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.
@type \Google\Protobuf\Internal\FeatureSet $features
      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.
@type bool $debug_redact
      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.
@type \Google\Protobuf\Internal\FieldOptions\FeatureSupport $feature_support
      Information about the support window of a feature value.
@type \Google\Protobuf\Internal\UninterpretedOption[] $uninterpreted_option
      The parser stores options it doesn't recognize here. See above.

}

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

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

ignore

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

Clear all containing fields.

return null

public clearDebugRedact()

public clearDeprecated()

public clearFeatures()

public clearFeatureSupport()

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

Clear all unknown fields previously parsed.

return null

public 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.

Generated from protobuf field optional bool debug_redact = 3 [default = false];

return bool

public 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.

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

return bool

public 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 = 2;

return \Google\Protobuf\Internal\FeatureSet|null

public getFeatureSupport()

Information about the support window of a feature value.

Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 4;

return \Google\Protobuf\Internal\FieldOptions\FeatureSupport|null

public getUninterpretedOption()

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

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

return \RepeatedField<\Google\Protobuf\Internal\UninterpretedOption>

public hasDebugRedact()

public hasDeprecated()

public hasFeatures()

public hasFeatureSupport()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $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.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $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.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $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.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

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

ignore

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

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

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 setDebugRedact( $var)

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.

Generated from protobuf field optional bool debug_redact = 3 [default = false];

param bool $var
return $this

public setDeprecated( $var)

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

param bool $var
return $this

public setFeatures( $var)

Any features defined in the specific edition.

Generated from protobuf field optional .google.protobuf.FeatureSet features = 2;

param \Google\Protobuf\Internal\FeatureSet $var
return $this

public setFeatureSupport( $var)

Information about the support window of a feature value.

Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 4;

param \Google\Protobuf\Internal\FieldOptions\FeatureSupport $var
return $this

public setUninterpretedOption( $var)

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

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

param \Google\Protobuf\Internal\UninterpretedOption[] $var
return $this

Properties

protected $debug_redact = NULL

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.

Generated from protobuf field optional bool debug_redact = 3 [default = false];

protected $deprecated = NULL

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

protected $feature_support = NULL

Information about the support window of a feature value.

Generated from protobuf field optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 4;

protected $features = NULL

Any features defined in the specific edition.

Generated from protobuf field optional .google.protobuf.FeatureSet features = 2;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::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.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

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 $uninterpreted_option = NULL

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

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