PHPFUI/InstaDoc

Experimental features to be included during client library generation.

These fields will be deprecated once the feature graduates and is enabled by default.

Generated from protobuf message google.api.PythonSettings.ExperimentalFeatures

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

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

@type bool $rest_async_io_enabled
      Enables generation of asynchronous REST clients if `rest` transport is
      enabled. By default, asynchronous REST clients will not be generated.
      This feature will be enabled by default 1 month after launching the
      feature in preview packages.
@type bool $protobuf_pythonic_types_enabled
      Enables generation of protobuf code using new types that are more
      Pythonic which are included in `protobuf>=5.29.x`. This feature will be
      enabled by default 1 month after launching the feature in preview
      packages.
@type bool $unversioned_package_disabled
      Disables generation of an unversioned Python package for this client
      library. This means that the module names will need to be versioned in
      import statements. For example `import google.cloud.library_v2` instead
      of `import google.cloud.library`.

}

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 Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getProtobufPythonicTypesEnabled()

Enables generation of protobuf code using new types that are more Pythonic which are included in protobuf>=5.29.x. This feature will be enabled by default 1 month after launching the feature in preview packages.

Generated from protobuf field bool protobuf_pythonic_types_enabled = 2;

return bool

public getRestAsyncIoEnabled()

Enables generation of asynchronous REST clients if rest transport is enabled. By default, asynchronous REST clients will not be generated.

This feature will be enabled by default 1 month after launching the feature in preview packages.

Generated from protobuf field bool rest_async_io_enabled = 1;

return bool

public getUnversionedPackageDisabled()

Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example import google.cloud.library_v2 instead of import google.cloud.library.

Generated from protobuf field bool unversioned_package_disabled = 3;

return bool

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

Generated from protobuf field bool protobuf_pythonic_types_enabled = 2;

param bool $var
return $this

public setRestAsyncIoEnabled( $var)

Enables generation of asynchronous REST clients if rest transport is enabled. By default, asynchronous REST clients will not be generated.

This feature will be enabled by default 1 month after launching the feature in preview packages.

Generated from protobuf field bool rest_async_io_enabled = 1;

param bool $var
return $this

public setUnversionedPackageDisabled( $var)

Generated from protobuf field bool unversioned_package_disabled = 3;

param bool $var
return $this

Properties

protected $protobuf_pythonic_types_enabled = false

Generated from protobuf field bool protobuf_pythonic_types_enabled = 2;

protected $rest_async_io_enabled = false

Enables generation of asynchronous REST clients if rest transport is enabled. By default, asynchronous REST clients will not be generated.

This feature will be enabled by default 1 month after launching the feature in preview packages.

Generated from protobuf field bool rest_async_io_enabled = 1;

protected $unversioned_package_disabled = false

Generated from protobuf field bool unversioned_package_disabled = 3;

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)