New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
A newer version is available. For the latest information, see the current release documentation.
« Elasticsearch\Client Elasticsearch\Namespaces\AsyncSearchNamespace »
Elastic Docs ›Elasticsearch PHP Client [7.17] ›Reference - Endpoints

Elasticsearch\ClientBuilder

edit

Elasticsearch\ClientBuilder

edit

Methods

The class defines the following methods:

create()

/*
Create an instance of ClientBuilder
*/

getTransport()

/*
Can supply first parm to Client::__construct() when invoking manually or with dependency injection
*/

getEndpoint()

/*
Can supply second parm to Client::__construct() when invoking manually or with dependency injection
*/

getRegisteredNamespacesBuilders()

/*
Can supply third parm to Client::__construct() when invoking manually or with dependency injection
*/

fromConfig(array $config, bool $quiet = false)

/*
Build a new client from the provided config.  Hash keys
should correspond to the method name e.g. ['connectionPool']
corresponds to setConnectionPool().
*/

defaultHandler(array $multiParams = [], array $singleParams = [])

/*
Get the default handler
*/

multiHandler(array $params = [])

/*
Get the multi handler for async (CurlMultiHandler)
*/

singleHandler()

/*
Get the handler instance (CurlHandler)
*/

setConnectionFactory(Elasticsearch\Connections\ConnectionFactoryInterface $connectionFactory)

/*
Set connection Factory
*/

setConnectionPool(AbstractConnectionPool|string $connectionPool, array $args = [])

/*
Set the connection pool (default is StaticNoPingConnectionPool)
*/

setEndpoint(callable $endpoint)

/*
Set the endpoint
*/

registerNamespace(Elasticsearch\Namespaces\NamespaceBuilderInterface $namespaceBuilder)

/*
Register namespace
*/

setTransport(Elasticsearch\Transport $transport)

/*
Set the transport
*/

setHandler(mixed $handler)

/*
Set the HTTP handler (cURL is default)
*/

setLogger(Psr\Log\LoggerInterface $logger)

/*
Set the PSR-3 Logger
*/

setTracer(Psr\Log\LoggerInterface $tracer)

/*
Set the PSR-3 tracer
*/

setSerializer(Elasticsearch\Serializers\SerializerInterface|string $serializer)

/*
Set the serializer
*/

setHosts(array $hosts)

/*
Set the hosts (nodes)
*/

setApiKey(string $id, string $apiKey)

/*
Set the APIKey Pair, consiting of the API Id and the ApiKey of the Response from /_security/api_key
*/

setBasicAuthentication(string $username, string $password)

/*
Set Basic access authentication
*/

setElasticCloudId(string $cloudId)

/*
Set Elastic Cloud ID to connect to Elastic Cloud
*/

setConnectionParams(array $params)

/*
Set connection parameters
*/

setRetries(int $retries)

/*
Set number or retries (default is equal to number of nodes)
*/

setSelector(Elasticsearch\ConnectionPool\Selectors\SelectorInterface|string $selector)

/*
Set the selector algorithm
*/

setSniffOnStart(bool $sniffOnStart)

/*
Set sniff on start
*/

setSSLCert(string $cert, string $password = null)

/*
Set SSL certificate
*/

setSSLKey(string $key, string $password = null)

/*
Set SSL key
*/

setSSLVerification(bool|string $value = true)

/*
Set SSL verification
*/

setElasticMetaHeader($value = true)

/*
Set or disable the x-elastic-client-meta header
*/

includePortInHostHeader(bool $enable)

/*
Include the port in Host header
*/

build()

/*
Build and returns the Client object
*/

instantiate(Elasticsearch\Transport $transport, callable $endpoint, array $registeredNamespaces)

/*
*/
« Elasticsearch\Client Elasticsearch\Namespaces\AsyncSearchNamespace »
Was this helpful?
Feedback