1 2 3[[Elasticsearch_ClientBuilder]] 4=== Elasticsearch\ClientBuilder 5 6 7 8 9*Methods* 10 11The class defines the following methods: 12 13* <<Elasticsearch_ClientBuildercreate_create,`create()`>> 14* <<Elasticsearch_ClientBuildergetTransport_getTransport,`getTransport()`>> 15* <<Elasticsearch_ClientBuildergetEndpoint_getEndpoint,`getEndpoint()`>> 16* <<Elasticsearch_ClientBuildergetRegisteredNamespacesBuilders_getRegisteredNamespacesBuilders,`getRegisteredNamespacesBuilders()`>> 17* <<Elasticsearch_ClientBuilderfromConfig_fromConfig,`fromConfig()`>> 18* <<Elasticsearch_ClientBuilderdefaultHandler_defaultHandler,`defaultHandler()`>> 19* <<Elasticsearch_ClientBuildermultiHandler_multiHandler,`multiHandler()`>> 20* <<Elasticsearch_ClientBuildersingleHandler_singleHandler,`singleHandler()`>> 21* <<Elasticsearch_ClientBuildersetConnectionFactory_setConnectionFactory,`setConnectionFactory()`>> 22* <<Elasticsearch_ClientBuildersetConnectionPool_setConnectionPool,`setConnectionPool()`>> 23* <<Elasticsearch_ClientBuildersetEndpoint_setEndpoint,`setEndpoint()`>> 24* <<Elasticsearch_ClientBuilderregisterNamespace_registerNamespace,`registerNamespace()`>> 25* <<Elasticsearch_ClientBuildersetTransport_setTransport,`setTransport()`>> 26* <<Elasticsearch_ClientBuildersetHandler_setHandler,`setHandler()`>> 27* <<Elasticsearch_ClientBuildersetLogger_setLogger,`setLogger()`>> 28* <<Elasticsearch_ClientBuildersetTracer_setTracer,`setTracer()`>> 29* <<Elasticsearch_ClientBuildersetSerializer_setSerializer,`setSerializer()`>> 30* <<Elasticsearch_ClientBuildersetHosts_setHosts,`setHosts()`>> 31* <<Elasticsearch_ClientBuildersetApiKey_setApiKey,`setApiKey()`>> 32* <<Elasticsearch_ClientBuildersetBasicAuthentication_setBasicAuthentication,`setBasicAuthentication()`>> 33* <<Elasticsearch_ClientBuildersetElasticCloudId_setElasticCloudId,`setElasticCloudId()`>> 34* <<Elasticsearch_ClientBuildersetConnectionParams_setConnectionParams,`setConnectionParams()`>> 35* <<Elasticsearch_ClientBuildersetRetries_setRetries,`setRetries()`>> 36* <<Elasticsearch_ClientBuildersetSelector_setSelector,`setSelector()`>> 37* <<Elasticsearch_ClientBuildersetSniffOnStart_setSniffOnStart,`setSniffOnStart()`>> 38* <<Elasticsearch_ClientBuildersetSSLCert_setSSLCert,`setSSLCert()`>> 39* <<Elasticsearch_ClientBuildersetSSLKey_setSSLKey,`setSSLKey()`>> 40* <<Elasticsearch_ClientBuildersetSSLVerification_setSSLVerification,`setSSLVerification()`>> 41* <<Elasticsearch_ClientBuildersetElasticMetaHeader_setElasticMetaHeader,`setElasticMetaHeader()`>> 42* <<Elasticsearch_ClientBuilderincludePortInHostHeader_includePortInHostHeader,`includePortInHostHeader()`>> 43* <<Elasticsearch_ClientBuilderbuild_build,`build()`>> 44* <<Elasticsearch_ClientBuilderinstantiate_instantiate,`instantiate()`>> 45 46 47 48[[Elasticsearch_ClientBuildercreate_create]] 49.`create()` 50**** 51[source,php] 52---- 53/* 54Create an instance of ClientBuilder 55*/ 56---- 57**** 58 59 60 61[[Elasticsearch_ClientBuildergetTransport_getTransport]] 62.`getTransport()` 63**** 64[source,php] 65---- 66/* 67Can supply first parm to Client::__construct() when invoking manually or with dependency injection 68*/ 69---- 70**** 71 72 73 74[[Elasticsearch_ClientBuildergetEndpoint_getEndpoint]] 75.`getEndpoint()` 76**** 77[source,php] 78---- 79/* 80Can supply second parm to Client::__construct() when invoking manually or with dependency injection 81*/ 82---- 83**** 84 85 86 87[[Elasticsearch_ClientBuildergetRegisteredNamespacesBuilders_getRegisteredNamespacesBuilders]] 88.`getRegisteredNamespacesBuilders()` 89**** 90[source,php] 91---- 92/* 93Can supply third parm to Client::__construct() when invoking manually or with dependency injection 94*/ 95---- 96**** 97 98 99 100[[Elasticsearch_ClientBuilderfromConfig_fromConfig]] 101.`fromConfig(array $config, bool $quiet = false)` 102**** 103[source,php] 104---- 105/* 106Build a new client from the provided config. Hash keys 107should correspond to the method name e.g. ['connectionPool'] 108corresponds to setConnectionPool(). 109*/ 110---- 111**** 112 113 114 115[[Elasticsearch_ClientBuilderdefaultHandler_defaultHandler]] 116.`defaultHandler(array $multiParams = [], array $singleParams = [])` 117**** 118[source,php] 119---- 120/* 121Get the default handler 122*/ 123---- 124**** 125 126 127 128[[Elasticsearch_ClientBuildermultiHandler_multiHandler]] 129.`multiHandler(array $params = [])` 130**** 131[source,php] 132---- 133/* 134Get the multi handler for async (CurlMultiHandler) 135*/ 136---- 137**** 138 139 140 141[[Elasticsearch_ClientBuildersingleHandler_singleHandler]] 142.`singleHandler()` 143**** 144[source,php] 145---- 146/* 147Get the handler instance (CurlHandler) 148*/ 149---- 150**** 151 152 153 154[[Elasticsearch_ClientBuildersetConnectionFactory_setConnectionFactory]] 155.`setConnectionFactory(Elasticsearch\Connections\ConnectionFactoryInterface $connectionFactory)` 156**** 157[source,php] 158---- 159/* 160Set connection Factory 161*/ 162---- 163**** 164 165 166 167[[Elasticsearch_ClientBuildersetConnectionPool_setConnectionPool]] 168.`setConnectionPool(AbstractConnectionPool|string $connectionPool, array $args = [])` 169**** 170[source,php] 171---- 172/* 173Set the connection pool (default is StaticNoPingConnectionPool) 174*/ 175---- 176**** 177 178 179 180[[Elasticsearch_ClientBuildersetEndpoint_setEndpoint]] 181.`setEndpoint(callable $endpoint)` 182**** 183[source,php] 184---- 185/* 186Set the endpoint 187*/ 188---- 189**** 190 191 192 193[[Elasticsearch_ClientBuilderregisterNamespace_registerNamespace]] 194.`registerNamespace(Elasticsearch\Namespaces\NamespaceBuilderInterface $namespaceBuilder)` 195**** 196[source,php] 197---- 198/* 199Register namespace 200*/ 201---- 202**** 203 204 205 206[[Elasticsearch_ClientBuildersetTransport_setTransport]] 207.`setTransport(Elasticsearch\Transport $transport)` 208**** 209[source,php] 210---- 211/* 212Set the transport 213*/ 214---- 215**** 216 217 218 219[[Elasticsearch_ClientBuildersetHandler_setHandler]] 220.`setHandler(mixed $handler)` 221**** 222[source,php] 223---- 224/* 225Set the HTTP handler (cURL is default) 226*/ 227---- 228**** 229 230 231 232[[Elasticsearch_ClientBuildersetLogger_setLogger]] 233.`setLogger(Psr\Log\LoggerInterface $logger)` 234**** 235[source,php] 236---- 237/* 238Set the PSR-3 Logger 239*/ 240---- 241**** 242 243 244 245[[Elasticsearch_ClientBuildersetTracer_setTracer]] 246.`setTracer(Psr\Log\LoggerInterface $tracer)` 247**** 248[source,php] 249---- 250/* 251Set the PSR-3 tracer 252*/ 253---- 254**** 255 256 257 258[[Elasticsearch_ClientBuildersetSerializer_setSerializer]] 259.`setSerializer(Elasticsearch\Serializers\SerializerInterface|string $serializer)` 260**** 261[source,php] 262---- 263/* 264Set the serializer 265*/ 266---- 267**** 268 269 270 271[[Elasticsearch_ClientBuildersetHosts_setHosts]] 272.`setHosts(array $hosts)` 273**** 274[source,php] 275---- 276/* 277Set the hosts (nodes) 278*/ 279---- 280**** 281 282 283 284[[Elasticsearch_ClientBuildersetApiKey_setApiKey]] 285.`setApiKey(string $id, string $apiKey)` 286**** 287[source,php] 288---- 289/* 290Set the APIKey Pair, consiting of the API Id and the ApiKey of the Response from /_security/api_key 291*/ 292---- 293**** 294 295 296 297[[Elasticsearch_ClientBuildersetBasicAuthentication_setBasicAuthentication]] 298.`setBasicAuthentication(string $username, string $password)` 299**** 300[source,php] 301---- 302/* 303Set Basic access authentication 304*/ 305---- 306**** 307 308 309 310[[Elasticsearch_ClientBuildersetElasticCloudId_setElasticCloudId]] 311.`setElasticCloudId(string $cloudId)` 312**** 313[source,php] 314---- 315/* 316Set Elastic Cloud ID to connect to Elastic Cloud 317*/ 318---- 319**** 320 321 322 323[[Elasticsearch_ClientBuildersetConnectionParams_setConnectionParams]] 324.`setConnectionParams(array $params)` 325**** 326[source,php] 327---- 328/* 329Set connection parameters 330*/ 331---- 332**** 333 334 335 336[[Elasticsearch_ClientBuildersetRetries_setRetries]] 337.`setRetries(int $retries)` 338**** 339[source,php] 340---- 341/* 342Set number or retries (default is equal to number of nodes) 343*/ 344---- 345**** 346 347 348 349[[Elasticsearch_ClientBuildersetSelector_setSelector]] 350.`setSelector(Elasticsearch\ConnectionPool\Selectors\SelectorInterface|string $selector)` 351**** 352[source,php] 353---- 354/* 355Set the selector algorithm 356*/ 357---- 358**** 359 360 361 362[[Elasticsearch_ClientBuildersetSniffOnStart_setSniffOnStart]] 363.`setSniffOnStart(bool $sniffOnStart)` 364**** 365[source,php] 366---- 367/* 368Set sniff on start 369*/ 370---- 371**** 372 373 374 375[[Elasticsearch_ClientBuildersetSSLCert_setSSLCert]] 376.`setSSLCert(string $cert, string $password = null)` 377**** 378[source,php] 379---- 380/* 381Set SSL certificate 382*/ 383---- 384**** 385 386 387 388[[Elasticsearch_ClientBuildersetSSLKey_setSSLKey]] 389.`setSSLKey(string $key, string $password = null)` 390**** 391[source,php] 392---- 393/* 394Set SSL key 395*/ 396---- 397**** 398 399 400 401[[Elasticsearch_ClientBuildersetSSLVerification_setSSLVerification]] 402.`setSSLVerification(bool|string $value = true)` 403**** 404[source,php] 405---- 406/* 407Set SSL verification 408*/ 409---- 410**** 411 412 413 414[[Elasticsearch_ClientBuildersetElasticMetaHeader_setElasticMetaHeader]] 415.`setElasticMetaHeader($value = true)` 416**** 417[source,php] 418---- 419/* 420Set or disable the x-elastic-client-meta header 421*/ 422---- 423**** 424 425 426 427[[Elasticsearch_ClientBuilderincludePortInHostHeader_includePortInHostHeader]] 428.`includePortInHostHeader(bool $enable)` 429**** 430[source,php] 431---- 432/* 433Include the port in Host header 434*/ 435---- 436**** 437 438 439 440[[Elasticsearch_ClientBuilderbuild_build]] 441.`build()` 442**** 443[source,php] 444---- 445/* 446Build and returns the Client object 447*/ 448---- 449**** 450 451 452 453[[Elasticsearch_ClientBuilderinstantiate_instantiate]] 454.`instantiate(Elasticsearch\Transport $transport, callable $endpoint, array $registeredNamespaces)` 455**** 456[source,php] 457---- 458/* 459*/ 460---- 461**** 462 463 464