Documentation

ClientLibrarySettings extends Message
in package

Details about how and where to publish client libraries.

Generated from protobuf message google.api.ClientLibrarySettings

Table of Contents

Properties

$cpp_settings  : mixed
Settings for C++ client libraries.
$dotnet_settings  : mixed
Settings for .NET client libraries.
$go_settings  : mixed
Settings for Go client libraries.
$java_settings  : mixed
Settings for legacy Java features, supported in the Service YAML.
$launch_stage  : mixed
Launch stage of this version of the API.
$node_settings  : mixed
Settings for Node client libraries.
$php_settings  : mixed
Settings for PHP client libraries.
$python_settings  : mixed
Settings for Python client libraries.
$rest_numeric_enums  : mixed
When using transport=rest, the client request will encode enums as numbers rather than strings.
$ruby_settings  : mixed
Settings for Ruby client libraries.
$version  : mixed
Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element.

Methods

__construct()  : mixed
Constructor.
clearCppSettings()  : mixed
clearDotnetSettings()  : mixed
clearGoSettings()  : mixed
clearJavaSettings()  : mixed
clearNodeSettings()  : mixed
clearPhpSettings()  : mixed
clearPythonSettings()  : mixed
clearRubySettings()  : mixed
getCppSettings()  : CppSettings|null
Settings for C++ client libraries.
getDotnetSettings()  : DotnetSettings|null
Settings for .NET client libraries.
getGoSettings()  : GoSettings|null
Settings for Go client libraries.
getJavaSettings()  : JavaSettings|null
Settings for legacy Java features, supported in the Service YAML.
getLaunchStage()  : int
Launch stage of this version of the API.
getNodeSettings()  : NodeSettings|null
Settings for Node client libraries.
getPhpSettings()  : PhpSettings|null
Settings for PHP client libraries.
getPythonSettings()  : PythonSettings|null
Settings for Python client libraries.
getRestNumericEnums()  : bool
When using transport=rest, the client request will encode enums as numbers rather than strings.
getRubySettings()  : RubySettings|null
Settings for Ruby client libraries.
getVersion()  : string
Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element.
hasCppSettings()  : mixed
hasDotnetSettings()  : mixed
hasGoSettings()  : mixed
hasJavaSettings()  : mixed
hasNodeSettings()  : mixed
hasPhpSettings()  : mixed
hasPythonSettings()  : mixed
hasRubySettings()  : mixed
setCppSettings()  : $this
Settings for C++ client libraries.
setDotnetSettings()  : $this
Settings for .NET client libraries.
setGoSettings()  : $this
Settings for Go client libraries.
setJavaSettings()  : $this
Settings for legacy Java features, supported in the Service YAML.
setLaunchStage()  : $this
Launch stage of this version of the API.
setNodeSettings()  : $this
Settings for Node client libraries.
setPhpSettings()  : $this
Settings for PHP client libraries.
setPythonSettings()  : $this
Settings for Python client libraries.
setRestNumericEnums()  : $this
When using transport=rest, the client request will encode enums as numbers rather than strings.
setRubySettings()  : $this
Settings for Ruby client libraries.
setVersion()  : $this
Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element.

Properties

$cpp_settings

Settings for C++ client libraries.

protected mixed $cpp_settings = null

Generated from protobuf field .google.api.CppSettings cpp_settings = 22 [json_name = "cppSettings"];

$dotnet_settings

Settings for .NET client libraries.

protected mixed $dotnet_settings = null

Generated from protobuf field .google.api.DotnetSettings dotnet_settings = 26 [json_name = "dotnetSettings"];

$go_settings

Settings for Go client libraries.

protected mixed $go_settings = null

Generated from protobuf field .google.api.GoSettings go_settings = 28 [json_name = "goSettings"];

$java_settings

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

protected mixed $java_settings = null

Generated from protobuf field .google.api.JavaSettings java_settings = 21 [json_name = "javaSettings"];

$launch_stage

Launch stage of this version of the API.

protected mixed $launch_stage = 0

Generated from protobuf field .google.api.LaunchStage launch_stage = 2 [json_name = "launchStage"];

$node_settings

Settings for Node client libraries.

protected mixed $node_settings = null

Generated from protobuf field .google.api.NodeSettings node_settings = 25 [json_name = "nodeSettings"];

$php_settings

Settings for PHP client libraries.

protected mixed $php_settings = null

Generated from protobuf field .google.api.PhpSettings php_settings = 23 [json_name = "phpSettings"];

$python_settings

Settings for Python client libraries.

protected mixed $python_settings = null

Generated from protobuf field .google.api.PythonSettings python_settings = 24 [json_name = "pythonSettings"];

$rest_numeric_enums

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

protected mixed $rest_numeric_enums = false

Generated from protobuf field bool rest_numeric_enums = 3 [json_name = "restNumericEnums"];

$ruby_settings

Settings for Ruby client libraries.

protected mixed $ruby_settings = null

Generated from protobuf field .google.api.RubySettings ruby_settings = 27 [json_name = "rubySettings"];

$version

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

protected mixed $version = ''

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

Generated from protobuf field string version = 1 [json_name = "version"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

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

}

getCppSettings()

Settings for C++ client libraries.

public getCppSettings() : CppSettings|null

Generated from protobuf field .google.api.CppSettings cpp_settings = 22 [json_name = "cppSettings"];

Return values
CppSettings|null

getDotnetSettings()

Settings for .NET client libraries.

public getDotnetSettings() : DotnetSettings|null

Generated from protobuf field .google.api.DotnetSettings dotnet_settings = 26 [json_name = "dotnetSettings"];

Return values
DotnetSettings|null

getGoSettings()

Settings for Go client libraries.

public getGoSettings() : GoSettings|null

Generated from protobuf field .google.api.GoSettings go_settings = 28 [json_name = "goSettings"];

Return values
GoSettings|null

getJavaSettings()

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

public getJavaSettings() : JavaSettings|null

Generated from protobuf field .google.api.JavaSettings java_settings = 21 [json_name = "javaSettings"];

Return values
JavaSettings|null

getLaunchStage()

Launch stage of this version of the API.

public getLaunchStage() : int

Generated from protobuf field .google.api.LaunchStage launch_stage = 2 [json_name = "launchStage"];

Return values
int

getNodeSettings()

Settings for Node client libraries.

public getNodeSettings() : NodeSettings|null

Generated from protobuf field .google.api.NodeSettings node_settings = 25 [json_name = "nodeSettings"];

Return values
NodeSettings|null

getPhpSettings()

Settings for PHP client libraries.

public getPhpSettings() : PhpSettings|null

Generated from protobuf field .google.api.PhpSettings php_settings = 23 [json_name = "phpSettings"];

Return values
PhpSettings|null

getPythonSettings()

Settings for Python client libraries.

public getPythonSettings() : PythonSettings|null

Generated from protobuf field .google.api.PythonSettings python_settings = 24 [json_name = "pythonSettings"];

Return values
PythonSettings|null

getRestNumericEnums()

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

public getRestNumericEnums() : bool

Generated from protobuf field bool rest_numeric_enums = 3 [json_name = "restNumericEnums"];

Return values
bool

getRubySettings()

Settings for Ruby client libraries.

public getRubySettings() : RubySettings|null

Generated from protobuf field .google.api.RubySettings ruby_settings = 27 [json_name = "rubySettings"];

Return values
RubySettings|null

getVersion()

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

public getVersion() : string

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

Generated from protobuf field string version = 1 [json_name = "version"];

Return values
string

setCppSettings()

Settings for C++ client libraries.

public setCppSettings(CppSettings $var) : $this

Generated from protobuf field .google.api.CppSettings cpp_settings = 22 [json_name = "cppSettings"];

Parameters
$var : CppSettings
Return values
$this

setDotnetSettings()

Settings for .NET client libraries.

public setDotnetSettings(DotnetSettings $var) : $this

Generated from protobuf field .google.api.DotnetSettings dotnet_settings = 26 [json_name = "dotnetSettings"];

Parameters
$var : DotnetSettings
Return values
$this

setGoSettings()

Settings for Go client libraries.

public setGoSettings(GoSettings $var) : $this

Generated from protobuf field .google.api.GoSettings go_settings = 28 [json_name = "goSettings"];

Parameters
$var : GoSettings
Return values
$this

setJavaSettings()

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

public setJavaSettings(JavaSettings $var) : $this

Generated from protobuf field .google.api.JavaSettings java_settings = 21 [json_name = "javaSettings"];

Parameters
$var : JavaSettings
Return values
$this

setLaunchStage()

Launch stage of this version of the API.

public setLaunchStage(int $var) : $this

Generated from protobuf field .google.api.LaunchStage launch_stage = 2 [json_name = "launchStage"];

Parameters
$var : int
Return values
$this

setNodeSettings()

Settings for Node client libraries.

public setNodeSettings(NodeSettings $var) : $this

Generated from protobuf field .google.api.NodeSettings node_settings = 25 [json_name = "nodeSettings"];

Parameters
$var : NodeSettings
Return values
$this

setPhpSettings()

Settings for PHP client libraries.

public setPhpSettings(PhpSettings $var) : $this

Generated from protobuf field .google.api.PhpSettings php_settings = 23 [json_name = "phpSettings"];

Parameters
$var : PhpSettings
Return values
$this

setPythonSettings()

Settings for Python client libraries.

public setPythonSettings(PythonSettings $var) : $this

Generated from protobuf field .google.api.PythonSettings python_settings = 24 [json_name = "pythonSettings"];

Parameters
$var : PythonSettings
Return values
$this

setRestNumericEnums()

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

public setRestNumericEnums(bool $var) : $this

Generated from protobuf field bool rest_numeric_enums = 3 [json_name = "restNumericEnums"];

Parameters
$var : bool
Return values
$this

setRubySettings()

Settings for Ruby client libraries.

public setRubySettings(RubySettings $var) : $this

Generated from protobuf field .google.api.RubySettings ruby_settings = 27 [json_name = "rubySettings"];

Parameters
$var : RubySettings
Return values
$this

setVersion()

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

public setVersion(string $var) : $this

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

Generated from protobuf field string version = 1 [json_name = "version"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results