1. class
  2. Google
  3. GAX
  4. CallSettings

CallSettings

class CallSettings

Encapsulates the call settings for an API call.

Constants

INHERIT_TIMEOUT

Methods

static 
load(string $serviceName, array $clientConfig, array $retryingOverrides, array $statusCodes, int $timeoutMillis)

Constructs an array mapping method names to CallSettings.

__construct($settings = array())

Construct an instance.

getTimeoutMillis()

No description

getRetrySettings()

No description

merge(CallSettings $otherSettings = null)

Returns a new CallSettings merged from this and another CallSettings object.

Details

at line line 65
static load(string $serviceName, array $clientConfig, array $retryingOverrides, array $statusCodes, int $timeoutMillis)

Constructs an array mapping method names to CallSettings.

Parameters

string $serviceName The fully-qualified name of this service, used as a key into the client config file.
array $clientConfig An array parsed from the standard API client config file.
array $retryingOverrides A dictionary of method names to RetrySettings that override those specified in $clientConfig.
array $statusCodes An array which maps the strings referring to response status codes to the PHP objects representing those codes.
int $timeoutMillis The timeout (in milliseconds) to use for calls that don't have a retry configured.

at line line 165
__construct($settings = array())

Construct an instance.

Parameters

$settings

at line line 178
getTimeoutMillis()

at line line 183
getRetrySettings()

at line line 195
merge(CallSettings $otherSettings = null)

Returns a new CallSettings merged from this and another CallSettings object.

Parameters

CallSettings $otherSettings A CallSettings whose values override those in this object. If null, then a copy of this object is returned.