Documentation

ClientBuilder
in package

Builder for creating AWS service clients

Table of Contents

Properties

$clientNamespace  : string
$commonConfigDefaults  : array<string|int, mixed>
$commonConfigRequirements  : array<string|int, mixed>
$config  : array<string|int, mixed>
$configDefaults  : array<string|int, mixed>
$configRequirements  : array<string|int, mixed>
$exceptionParser  : ExceptionParserInterface
$iteratorsConfig  : array<string|int, mixed>
$clientClass  : string
$serviceName  : string

Methods

__construct()  : mixed
Constructs a client builder
build()  : AwsClientInterface
Performs the building logic using all of the parameters that have been set and falling back to default values. Returns an instantiate service client with credentials prepared and plugins attached.
factory()  : ClientBuilder
Factory method for creating the client builder
setConfig()  : ClientBuilder
Sets the config options
setConfigDefaults()  : ClientBuilder
Sets the config options' defaults
setConfigRequirements()  : ClientBuilder
Sets the required config options
setExceptionParser()  : ClientBuilder
Sets the exception parser. If one is not provided the builder will use the default XML exception parser.
setIteratorsConfig()  : ClientBuilder
Set the configuration for the client's iterators
addBackoffLogger()  : mixed
Add backoff logging to the backoff plugin if needed
getCredentials()  : mixed
getSignature()  : SignatureInterface
Return an appropriate signature object for a a client based on the "signature" configuration setting, or the default signature specified in a service description. The signature can be set to a valid signature version identifier string or an instance of Aws\Common\Signature\SignatureInterface.
processArray()  : array<string|int, mixed>
Ensures that an array (e.g. for config data) is actually in array form
updateConfigFromDescription()  : ServiceDescription
Update a configuration object from a service description
createDefaultBackoff()  : mixed
extractHttpConfig()  : mixed
handleEndpoint()  : mixed
handleRegion()  : mixed

Properties

$clientNamespace

protected string $clientNamespace

The namespace of the client

$commonConfigDefaults

protected static array<string|int, mixed> $commonConfigDefaults = array('scheme' => 'https')

Default client config

$commonConfigRequirements

protected static array<string|int, mixed> $commonConfigRequirements = array(\Aws\Common\Enum\ClientOptions::SERVICE_DESCRIPTION)

Default client requirements

$config

protected array<string|int, mixed> $config = array()

The config options

$configDefaults

protected array<string|int, mixed> $configDefaults = array()

The config defaults

$configRequirements

protected array<string|int, mixed> $configRequirements = array()

The config requirements

$iteratorsConfig

protected array<string|int, mixed> $iteratorsConfig = array()

Array of configuration data for iterators available for the client

Methods

__construct()

Constructs a client builder

public __construct([string $namespace = null ]) : mixed
Parameters
$namespace : string = null

The namespace of the client

factory()

Factory method for creating the client builder

public static factory([string $namespace = null ]) : ClientBuilder
Parameters
$namespace : string = null

The namespace of the client

Return values
ClientBuilder

setIteratorsConfig()

Set the configuration for the client's iterators

public setIteratorsConfig(array<string|int, mixed> $config) : ClientBuilder
Parameters
$config : array<string|int, mixed>

Configuration data for client's iterators

Return values
ClientBuilder

getSignature()

Return an appropriate signature object for a a client based on the "signature" configuration setting, or the default signature specified in a service description. The signature can be set to a valid signature version identifier string or an instance of Aws\Common\Signature\SignatureInterface.

protected getSignature(ServiceDescription $description, Collection $config) : SignatureInterface
Parameters
$description : ServiceDescription

Description that holds a signature option

$config : Collection

Configuration options

Tags
throws
InvalidArgumentException
Return values
SignatureInterface

processArray()

Ensures that an array (e.g. for config data) is actually in array form

protected processArray(array<string|int, mixed>|Collection $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>|Collection

The array data

Tags
throws
InvalidArgumentException

if the arg is not an array or Collection

Return values
array<string|int, mixed>

createDefaultBackoff()

private createDefaultBackoff() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results