Reference documentation and code samples for the Google API Core Client class ClientOptions.
The ClientOptions class adds typing to the associative array of options passed into each API client constructor. To use this class directly, pass the result of Google\ApiCore\Options\ClientOptions::toArray() to the client constructor:
use Google\ApiCore\ClientOptions;
use Google\Cloud\SecretManager\Client\SecretManagerClient;
$options = new ClientOptions([
'credentials' => '/path/to/my/credentials.json'
]);
$secretManager = new SecretManagerClient($options->toArray());
Note: It's possible to pass an associative array to the API clients as well, as ClientOptions will still be used internally for validation.
Namespace
Google \ ApiCore \ OptionsMethods
__construct
Parameters | |
---|---|
Name | Description |
options |
array
{
@type string $apiEndpoint
The address of the API remote host, for example "example.googleapis.com. May also
include the port, for example "example.googleapis.com:443"
@type bool $disableRetries
Determines whether or not retries defined by the client configuration should be
disabled. Defaults to |
↳ apiEndpoint |
string
The address of the API remote host, for example "example.googleapis.com. May also include the port, for example "example.googleapis.com:443" |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed \Google\Auth\FetchAuthTokenInterface object or \Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $authConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see \Google\ApiCore\CredentialsWrapper::build. |
↳ transport |
string|TransportInterface|null
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], 'grpc-fallback' => [...], ]; See the GrpcTransport::build and RestTransport::build methods for the supported options. |
↳ versionFile |
string
The path to a file which contains the current version of the client. |
↳ descriptorsConfigPath |
string
The path to a descriptor configuration file. |
↳ serviceName |
string
The name of the service. |
↳ libName |
string
The name of the client application. |
↳ libVersion |
string
The version of the client application. |
↳ gapicVersion |
string
The code generator version of the GAPIC library. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. |
↳ universeDomain |
string
The default service domain for a given Cloud universe. |
↳ apiKey |
string
The API key to be used for the client. |
setApiEndpoint
Parameter | |
---|---|
Name | Description |
apiEndpoint |
?string
|
setDisableRetries
Parameter | |
---|---|
Name | Description |
disableRetries |
bool
|
setClientConfig
Parameter | |
---|---|
Name | Description |
clientConfig |
string|array
|
setCredentials
Parameter | |
---|---|
Name | Description |
credentials |
string|array|Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper|null
|
setCredentialsConfig
Parameter | |
---|---|
Name | Description |
credentialsConfig |
array
|
setTransport
Parameter | |
---|---|
Name | Description |
transport |
string|Google\ApiCore\Transport\TransportInterface|null
|
setTransportConfig
Parameter | |
---|---|
Name | Description |
transportConfig |
Google\ApiCore\Options\TransportOptions
|
setVersionFile
Parameter | |
---|---|
Name | Description |
versionFile |
?string
|
setServiceName
Parameter | |
---|---|
Name | Description |
serviceName |
?string
|
setLibName
Parameter | |
---|---|
Name | Description |
libName |
?string
|
setLibVersion
Parameter | |
---|---|
Name | Description |
libVersion |
?string
|
setGapicVersion
Parameter | |
---|---|
Name | Description |
gapicVersion |
?string
|
setClientCertSource
Parameter | |
---|---|
Name | Description |
clientCertSource |
?callable
|
setUniverseDomain
Parameter | |
---|---|
Name | Description |
universeDomain |
string
|
setApiKey
Parameter | |
---|---|
Name | Description |
apiKey |
string
|