PHP Interface Smile\ElasticsuiteCore\Api\Client\ClientConfigurationInterface

Author: Aurelien FOUCRET ([email protected])
Show file Open project: smile-sa/elasticsuite Interface Usage Examples

Public Methods

Method Description
getConnectionTimeout ( ) : integer Default connect timeout for the ES client.
getHttpAuthPassword ( ) : string Return the basic HTTP authentication password.
getHttpAuthUser ( ) : string Return the basic HTTP authentication user.
getScheme ( ) : string Indicates the protocol scheme used (http/https).
getServerList ( ) : array Return the list of configured ES Servers (client nodes).
isDebugModeEnabled ( ) : boolean Indicates whether the debug node is enabled or not.
isHttpAuthEnabled ( ) : boolean Indicates whether basic HTTP authentication on the node is enabled or not.

Method Details

getConnectionTimeout() public method

Default connect timeout for the ES client.
public getConnectionTimeout ( ) : integer
return integer

getHttpAuthPassword() public method

Return the basic HTTP authentication password.
public getHttpAuthPassword ( ) : string
return string

getHttpAuthUser() public method

Return the basic HTTP authentication user.
public getHttpAuthUser ( ) : string
return string

getScheme() public method

Indicates the protocol scheme used (http/https).
public getScheme ( ) : string
return string

getServerList() public method

Return the list of configured ES Servers (client nodes).
public getServerList ( ) : array
return array

isDebugModeEnabled() public method

Indicates whether the debug node is enabled or not.
public isDebugModeEnabled ( ) : boolean
return boolean

isHttpAuthEnabled() public method

Indicates whether basic HTTP authentication on the node is enabled or not.
public isHttpAuthEnabled ( ) : boolean
return boolean