PHPFUI/InstaDoc
 
Copied!

Details about how and where to publish client libraries.

Generated from protobuf message google.api.ClientLibrarySettings

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $version
      Version of the API to apply these settings to. This is the full protobuf
      package for the API, ending in the version element.
      Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
@type int $launch_stage
      Launch stage of this version of the API.
@type bool $rest_numeric_enums
      When using transport=rest, the client request will encode enums as
      numbers rather than strings.
@type \Google\Api\JavaSettings $java_settings
      Settings for legacy Java features, supported in the Service YAML.
@type \Google\Api\CppSettings $cpp_settings
      Settings for C++ client libraries.
@type \Google\Api\PhpSettings $php_settings
      Settings for PHP client libraries.
@type \Google\Api\PythonSettings $python_settings
      Settings for Python client libraries.
@type \Google\Api\NodeSettings $node_settings
      Settings for Node client libraries.
@type \Google\Api\DotnetSettings $dotnet_settings
      Settings for .NET client libraries.
@type \Google\Api\RubySettings $ruby_settings
      Settings for Ruby client libraries.
@type \Google\Api\GoSettings $go_settings
      Settings for Go client libraries.
    }
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 clearCppSettings()
public clearDotnetSettings()
public clearGoSettings()
public clearJavaSettings()
public clearNodeSettings()
public clearPhpSettings()
public clearPythonSettings()
public clearRubySettings()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getCppSettings()
 

Settings for C++ client libraries.

Generated from protobuf field .google.api.CppSettings cpp_settings = 22;

  • return \Google\Api\CppSettings|null
public getDotnetSettings()
 

Settings for .NET client libraries.

Generated from protobuf field .google.api.DotnetSettings dotnet_settings = 26;

  • return \Google\Api\DotnetSettings|null
public getGoSettings()
 

Settings for Go client libraries.

Generated from protobuf field .google.api.GoSettings go_settings = 28;

  • return \Google\Api\GoSettings|null
public getJavaSettings()
 

Settings for legacy Java features, supported in the Service YAML.

Generated from protobuf field .google.api.JavaSettings java_settings = 21;

  • return \Google\Api\JavaSettings|null
public getLaunchStage()
 

Launch stage of this version of the API.

Generated from protobuf field .google.api.LaunchStage launch_stage = 2;

  • return int
public getNodeSettings()
 

Settings for Node client libraries.

Generated from protobuf field .google.api.NodeSettings node_settings = 25;

  • return \Google\Api\NodeSettings|null
public getPhpSettings()
 

Settings for PHP client libraries.

Generated from protobuf field .google.api.PhpSettings php_settings = 23;

  • return \Google\Api\PhpSettings|null
public getPythonSettings()
 

Settings for Python client libraries.

Generated from protobuf field .google.api.PythonSettings python_settings = 24;

  • return \Google\Api\PythonSettings|null
public getRestNumericEnums()
 

When using transport=rest, the client request will encode enums as numbers rather than strings.

Generated from protobuf field bool rest_numeric_enums = 3;

  • return bool
public getRubySettings()
 

Settings for Ruby client libraries.

Generated from protobuf field .google.api.RubySettings ruby_settings = 27;

  • return \Google\Api\RubySettings|null
public getVersion()
 

Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element.

Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".

Generated from protobuf field string version = 1;

  • return string
public hasCppSettings()
public hasDotnetSettings()
public hasGoSettings()
public hasJavaSettings()
public hasNodeSettings()
public hasPhpSettings()
public hasPythonSettings()
public hasRubySettings()
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 setCppSettings( $var)
 

Settings for C++ client libraries.

Generated from protobuf field .google.api.CppSettings cpp_settings = 22;

  • param \Google\Api\CppSettings $var
  • return $this
public setDotnetSettings( $var)
 

Settings for .NET client libraries.

Generated from protobuf field .google.api.DotnetSettings dotnet_settings = 26;

  • param \Google\Api\DotnetSettings $var
  • return $this
public setGoSettings( $var)
 

Settings for Go client libraries.

Generated from protobuf field .google.api.GoSettings go_settings = 28;

  • param \Google\Api\GoSettings $var
  • return $this
public setJavaSettings( $var)
 

Settings for legacy Java features, supported in the Service YAML.

Generated from protobuf field .google.api.JavaSettings java_settings = 21;

  • param \Google\Api\JavaSettings $var
  • return $this
public setLaunchStage( $var)
 

Launch stage of this version of the API.

Generated from protobuf field .google.api.LaunchStage launch_stage = 2;

  • param int $var
  • return $this
public setNodeSettings( $var)
 

Settings for Node client libraries.

Generated from protobuf field .google.api.NodeSettings node_settings = 25;

  • param \Google\Api\NodeSettings $var
  • return $this
public setPhpSettings( $var)
 

Settings for PHP client libraries.

Generated from protobuf field .google.api.PhpSettings php_settings = 23;

  • param \Google\Api\PhpSettings $var
  • return $this
public setPythonSettings( $var)
 

Settings for Python client libraries.

Generated from protobuf field .google.api.PythonSettings python_settings = 24;

  • param \Google\Api\PythonSettings $var
  • return $this
public setRestNumericEnums( $var)
 

When using transport=rest, the client request will encode enums as numbers rather than strings.

Generated from protobuf field bool rest_numeric_enums = 3;

  • param bool $var
  • return $this
public setRubySettings( $var)
 

Settings for Ruby client libraries.

Generated from protobuf field .google.api.RubySettings ruby_settings = 27;

  • param \Google\Api\RubySettings $var
  • return $this
public setVersion( $var)
 

Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element.

Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".

Generated from protobuf field string version = 1;

  • param string $var
  • return $this
Properties
protected $cpp_settings = NULL
 

Settings for C++ client libraries.

Generated from protobuf field .google.api.CppSettings cpp_settings = 22;

protected $dotnet_settings = NULL
 

Settings for .NET client libraries.

Generated from protobuf field .google.api.DotnetSettings dotnet_settings = 26;

protected $go_settings = NULL
 

Settings for Go client libraries.

Generated from protobuf field .google.api.GoSettings go_settings = 28;

protected $java_settings = NULL
 

Settings for legacy Java features, supported in the Service YAML.

Generated from protobuf field .google.api.JavaSettings java_settings = 21;

protected $launch_stage = 0
 

Launch stage of this version of the API.

Generated from protobuf field .google.api.LaunchStage launch_stage = 2;

protected $node_settings = NULL
 

Settings for Node client libraries.

Generated from protobuf field .google.api.NodeSettings node_settings = 25;

protected $php_settings = NULL
 

Settings for PHP client libraries.

Generated from protobuf field .google.api.PhpSettings php_settings = 23;

protected $python_settings = NULL
 

Settings for Python client libraries.

Generated from protobuf field .google.api.PythonSettings python_settings = 24;

protected $rest_numeric_enums = false
 

When using transport=rest, the client request will encode enums as numbers rather than strings.

Generated from protobuf field bool rest_numeric_enums = 3;

protected $ruby_settings = NULL
 

Settings for Ruby client libraries.

Generated from protobuf field .google.api.RubySettings ruby_settings = 27;

protected $version = ''
 

Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element.

Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".

Generated from protobuf field string version = 1;

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)
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration