1. class
  2. Google
  3. \
  4. GAX
  5. \
  6. CallSettings

CallSettings

class CallSettings

Encapsulates the call settings for an API call.

Constants

INHERIT_TIMEOUT

Methods

static CallSettings[]
load(string $serviceName, array $clientConfig, array $retryingOverrides, array $statusCodes, int $timeoutMillisDefault)

Constructs an array mapping method names to CallSettings.

__construct(array $settings = [])

Construct an instance.

getTimeoutMillis()

No description

getRetrySettings()

No description

getUserHeaders()

No description

CallSettings
merge(CallSettings $otherSettings = null)

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

Details

at line 69
static CallSettings[] load(string $serviceName, array $clientConfig, array $retryingOverrides, array $statusCodes, int $timeoutMillisDefault)

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 $timeoutMillisDefault The timeout (in milliseconds) to use for calls that don't have a retry configured, and don't have timeout_millis set in $clientConfig.

Return Value

CallSettings[] $callSettings

at line 178
__construct(array $settings = [])

Construct an instance.

Parameters

array $settings { Optional. @type \Google\GAX\RetrySettings $retrySettings Retry settings to use for this method. If present, then $timeout is ignored. @type integer $timeoutMillis Timeout to use for the call. Only used if $retrySettings is not set. @type array $userHeaders An array of headers to be included in the request. }

at line 194
getTimeoutMillis()

at line 199
getRetrySettings()

at line 204
getUserHeaders()

at line 217
CallSettings 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.

Return Value

CallSettings