Google\Protobuf\Internal\FeatureSet | Google Protobuf

class FeatureSet extends Message (View source)

TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.

Generated from protobuf message google.protobuf.FeatureSet

Properties

protected	$field_presence	Generated from protobuf field `optional .google.protobuf.FeatureSet.FieldPresence field_presence = 1 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {`
protected	$enum_type	Generated from protobuf field `optional .google.protobuf.FeatureSet.EnumType enum_type = 2 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_ENUM, targets = TARGET_TYPE_FILE, edition_defaults = {`
protected	$repeated_field_encoding	Generated from protobuf field `optional .google.protobuf.FeatureSet.RepeatedFieldEncoding repeated_field_encoding = 3 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {`
protected	$utf8_validation	Generated from protobuf field `optional .google.protobuf.FeatureSet.Utf8Validation utf8_validation = 4 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {`
protected	$message_encoding	Generated from protobuf field `optional .google.protobuf.FeatureSet.MessageEncoding message_encoding = 5 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {`
protected	$json_format	Generated from protobuf field `optional .google.protobuf.FeatureSet.JsonFormat json_format = 6 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_MESSAGE, targets = TARGET_TYPE_ENUM, targets = TARGET_TYPE_FILE, edition_defaults = {`
protected	$enforce_naming_style	Generated from protobuf field `optional .google.protobuf.FeatureSet.EnforceNamingStyle enforce_naming_style = 7 [retention = RETENTION_SOURCE, targets = TARGET_TYPE_FILE, targets = TARGET_TYPE_EXTENSION_RANGE, targets = TARGET_TYPE_MESSAGE, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_ONEOF, targets = TARGET_TYPE_ENUM, targets = TARGET_TYPE_ENUM_ENTRY, targets = TARGET_TYPE_SERVICE, targets = TARGET_TYPE_METHOD, edition_defaults = {`
protected	$default_symbol_visibility	Generated from protobuf field `optional .google.protobuf.FeatureSet.VisibilityFeature.DefaultSymbolVisibility default_symbol_visibility = 8 [retention = RETENTION_SOURCE, targets = TARGET_TYPE_FILE, edition_defaults = {`

Methods

__construct($data = NULL)

Constructor.

readWrapperValue($member)

No description

from Message

writeWrapperValue($member, $value)

No description

from Message

readOneof($number)

No description

from Message

hasOneof($number)

No description

from Message

writeOneof($number, $value)

No description

from Message

whichOneof($oneof_name)

No description

from Message

null

clear()

Clear all containing fields.

from Message

null

discardUnknownFields()

Clear all unknown fields previously parsed.

from Message

null

mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from Message

null

mergeFromString(string $data)

Parses a protocol buffer contained in a string.

from Message

null

mergeFromJsonString(string $data, bool $ignore_unknown = false)

Parses a json string to protobuf message.

from Message

parseFromStream($input)

No description

from Message

null

mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

from Message

mergeFromJsonArray($array, $ignore_unknown)

No description

from Message

parseFromJsonStream($input, $ignore_unknown)

No description

from Message

serializeToStream($output)

No description

from Message

serializeToJsonStream($output)

No description

from Message

string

serializeToString()

Serialize the message to string.

from Message

string

serializeToJsonString($options = 0)

Serialize the message to json string.

from Message

byteSize()

No description

from Message

jsonByteSize($options = 0)

No description

from Message

__debugInfo()

No description

from Message

int

getFieldPresence()

Generated from protobuf field optional .google.protobuf.FeatureSet.FieldPresence field_presence = 1 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {

hasFieldPresence()

No description

clearFieldPresence()

No description

$this

setFieldPresence(int $var)

int

getEnumType()

Generated from protobuf field optional .google.protobuf.FeatureSet.EnumType enum_type = 2 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_ENUM, targets = TARGET_TYPE_FILE, edition_defaults = {

hasEnumType()

No description

clearEnumType()

No description

$this

setEnumType(int $var)

int

getRepeatedFieldEncoding()

Generated from protobuf field optional .google.protobuf.FeatureSet.RepeatedFieldEncoding repeated_field_encoding = 3 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {

hasRepeatedFieldEncoding()

No description

clearRepeatedFieldEncoding()

No description

$this

setRepeatedFieldEncoding(int $var)

int

getUtf8Validation()

Generated from protobuf field optional .google.protobuf.FeatureSet.Utf8Validation utf8_validation = 4 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {

hasUtf8Validation()

No description

clearUtf8Validation()

No description

$this

setUtf8Validation(int $var)

int

getMessageEncoding()

Generated from protobuf field optional .google.protobuf.FeatureSet.MessageEncoding message_encoding = 5 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_FILE, edition_defaults = {

hasMessageEncoding()

No description

clearMessageEncoding()

No description

$this

setMessageEncoding(int $var)

int

getJsonFormat()

Generated from protobuf field optional .google.protobuf.FeatureSet.JsonFormat json_format = 6 [retention = RETENTION_RUNTIME, targets = TARGET_TYPE_MESSAGE, targets = TARGET_TYPE_ENUM, targets = TARGET_TYPE_FILE, edition_defaults = {

hasJsonFormat()

No description

clearJsonFormat()

No description

$this

setJsonFormat(int $var)

int

getEnforceNamingStyle()

Generated from protobuf field optional .google.protobuf.FeatureSet.EnforceNamingStyle enforce_naming_style = 7 [retention = RETENTION_SOURCE, targets = TARGET_TYPE_FILE, targets = TARGET_TYPE_EXTENSION_RANGE, targets = TARGET_TYPE_MESSAGE, targets = TARGET_TYPE_FIELD, targets = TARGET_TYPE_ONEOF, targets = TARGET_TYPE_ENUM, targets = TARGET_TYPE_ENUM_ENTRY, targets = TARGET_TYPE_SERVICE, targets = TARGET_TYPE_METHOD, edition_defaults = {

hasEnforceNamingStyle()

No description

clearEnforceNamingStyle()

No description

$this

setEnforceNamingStyle(int $var)

int

getDefaultSymbolVisibility()

Generated from protobuf field optional .google.protobuf.FeatureSet.VisibilityFeature.DefaultSymbolVisibility default_symbol_visibility = 8 [retention = RETENTION_SOURCE, targets = TARGET_TYPE_FILE, edition_defaults = {

hasDefaultSymbolVisibility()

No description

clearDefaultSymbolVisibility()

No description

$this

setDefaultSymbolVisibility(int $var)

null

in Message at line 683
`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.

Parameters

object

$msg

Protobuf message to be merged from.

Return Value

null

in Message at line 751
`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.

Parameters

string

$data

Binary protobuf data.

Return Value

null

Exceptions

Exception

in Message at line 770
`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.

Parameters

string	$data	Json protobuf data.
bool	$ignore_unknown

Return Value

null

Exceptions

Exception

in Message at line 779
`parseFromStream($input)`

No description

Parameters

$input

in Message at line 1037
`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.

Parameters

array

$array

An array containing message properties and values.

Return Value

null

in Message at line 1126
`protected mergeFromJsonArray($array, $ignore_unknown)`

No description

Parameters

	$array
	$ignore_unknown

in Message at line 1322
`parseFromJsonStream($input, $ignore_unknown)`

No description

Parameters

	$input
	$ignore_unknown

in Message at line 1455
`serializeToStream($output)`

No description

Parameters

$output

int

$var

Return Value

$this

FeatureSet

Properties

Methods

Details

at line 75 __construct($data = NULL)

Parameters

in Message at line 158 protected readWrapperValue($member)

Parameters

in Message at line 175 protected writeWrapperValue($member, $value)

Parameters

in Message at line 194 protected readOneof($number)

Parameters

in Message at line 207 protected hasOneof($number)

Parameters

in Message at line 216 protected writeOneof($number, $value)

Parameters

in Message at line 231 protected whichOneof($oneof_name)

Parameters

in Message at line 527 null clear()

Return Value

in Message at line 637 null discardUnknownFields()

Return Value

in Message at line 683 null mergeFrom(object $msg)

Parameters

Return Value

in Message at line 751 null mergeFromString(string $data)

Parameters

Return Value

Exceptions

in Message at line 770 null mergeFromJsonString(string $data, bool $ignore_unknown = false)

Parameters

Return Value

Exceptions

in Message at line 779 parseFromStream($input)

Parameters

in Message at line 1037 protected null mergeFromArray(array $array)

Parameters

Return Value

in Message at line 1126 protected mergeFromJsonArray($array, $ignore_unknown)

Parameters

in Message at line 1322 parseFromJsonStream($input, $ignore_unknown)

Parameters

in Message at line 1455 serializeToStream($output)

Parameters

in Message at line 1470 serializeToJsonStream($output)

Parameters

in Message at line 1562 string serializeToString()

Return Value

in Message at line 1573 string serializeToJsonString($options = 0)

Parameters

Return Value

in Message at line 1941 byteSize()

in Message at line 1982 jsonByteSize($options = 0)

Parameters

in Message at line 2057 __debugInfo()

at line 84 int getFieldPresence()

Return Value

at line 89 hasFieldPresence()

at line 94 clearFieldPresence()

at line 104 $this setFieldPresence(int $var)

Parameters

Return Value

at line 116 int getEnumType()

Return Value

at line 121 hasEnumType()

at line 126 clearEnumType()

at line 136 $this setEnumType(int $var)

Parameters

Return Value

at line 148 int getRepeatedFieldEncoding()

Return Value

at line 153 hasRepeatedFieldEncoding()

at line 158 clearRepeatedFieldEncoding()

at line 168 $this setRepeatedFieldEncoding(int $var)

Parameters

Return Value

at line 180 int getUtf8Validation()

Return Value

at line 185 hasUtf8Validation()

at line 190 clearUtf8Validation()

at line 75
`__construct($data = NULL)`

in Message at line 158
`protected readWrapperValue($member)`

in Message at line 175
`protected writeWrapperValue($member, $value)`

in Message at line 194
`protected readOneof($number)`

in Message at line 207
`protected hasOneof($number)`

in Message at line 216
`protected writeOneof($number, $value)`

in Message at line 231
`protected whichOneof($oneof_name)`

in Message at line 527
`null clear()`

in Message at line 637
`null discardUnknownFields()`

in Message at line 683
`null mergeFrom(object $msg)`

in Message at line 751
`null mergeFromString(string $data)`

in Message at line 770
`null mergeFromJsonString(string $data, bool $ignore_unknown = false)`

in Message at line 779
`parseFromStream($input)`

in Message at line 1037
`protected null mergeFromArray(array $array)`

in Message at line 1126
`protected mergeFromJsonArray($array, $ignore_unknown)`

in Message at line 1322
`parseFromJsonStream($input, $ignore_unknown)`

in Message at line 1455
`serializeToStream($output)`

in Message at line 1470
`serializeToJsonStream($output)`

in Message at line 1562
`string serializeToString()`

in Message at line 1573
`string serializeToJsonString($options = 0)`

in Message at line 1941
`byteSize()`

in Message at line 1982
`jsonByteSize($options = 0)`

in Message at line 2057
`__debugInfo()`

at line 84
`int getFieldPresence()`

at line 89
`hasFieldPresence()`

at line 94
`clearFieldPresence()`

at line 104
`$this setFieldPresence(int $var)`

at line 116
`int getEnumType()`

at line 121
`hasEnumType()`

at line 126
`clearEnumType()`

at line 136
`$this setEnumType(int $var)`

at line 148
`int getRepeatedFieldEncoding()`

at line 153
`hasRepeatedFieldEncoding()`

at line 158
`clearRepeatedFieldEncoding()`

at line 168
`$this setRepeatedFieldEncoding(int $var)`

at line 180
`int getUtf8Validation()`

at line 185
`hasUtf8Validation()`

at line 190
`clearUtf8Validation()`

at line 200
`$this setUtf8Validation(int $var)`

at line 212
`int getMessageEncoding()`

at line 217
`hasMessageEncoding()`

at line 222
`clearMessageEncoding()`

at line 232
`$this setMessageEncoding(int $var)`

at line 244
`int getJsonFormat()`

at line 249
`hasJsonFormat()`

at line 254
`clearJsonFormat()`

at line 264
`$this setJsonFormat(int $var)`

at line 276
`int getEnforceNamingStyle()`

at line 281
`hasEnforceNamingStyle()`

at line 286
`clearEnforceNamingStyle()`

at line 296
`$this setEnforceNamingStyle(int $var)`

at line 308
`int getDefaultSymbolVisibility()`

at line 313
`hasDefaultSymbolVisibility()`

at line 318
`clearDefaultSymbolVisibility()`

at line 328
`$this setDefaultSymbolVisibility(int $var)`