CirrusSearch\BulkUpdateRequestLog Class Reference

Request log for requests that update the elasticsearch cluster. More...

Inheritance diagram for CirrusSearch\BulkUpdateRequestLog:

Collaboration diagram for CirrusSearch\BulkUpdateRequestLog:

Public Member Functions
	__construct (\Elastica\Client $client, $description, $queryType, array $extra=[])
	finish ()
	Called when the network request has finished.
	isCachedResponse ()
	getElasticTookMs ()
	getLogVariables ()
	getRequests ()
	We could generate multiple items for each bulk update that was sent..but doesn't seem necessary (yet).
Public Member Functions inherited from CirrusSearch\BaseRequestLog
	__construct ( $description, $queryType, array $extra=[])
	start ()
	Called when the network request is started.
	getTookMs ()
	getDescription ()
	getQueryType ()
	formatDescription ()
	Perform a quick and dirty replacement for $this->description when it's not going through monolog.

Additional Inherited Members
Protected Attributes inherited from CirrusSearch\BaseRequestLog
	$description
	$queryType
	$extra
	$startTime
	$endTime

Detailed Description

Request log for requests that update the elasticsearch cluster.

All update requests are done through bulk actions.

Constructor & Destructor Documentation

__construct()

CirrusSearch\BulkUpdateRequestLog::__construct	(	\Elastica\Client	$client,
			$description,
			$queryType,
		array	$extra = [] )

Parameters

\Elastica\Client	$client
string	$description
string	$queryType
array	$extra

Member Function Documentation

finish()

CirrusSearch\BulkUpdateRequestLog::finish

(

)

Called when the network request has finished.

Reimplemented from CirrusSearch\BaseRequestLog.

getElasticTookMs()

CirrusSearch\BulkUpdateRequestLog::getElasticTookMs

(

)

Returns

int The number of ms elasticsearch reported spending on the request, or -1 if no request was made (such as cached responses).

Implements CirrusSearch\RequestLog.

getLogVariables()

CirrusSearch\BulkUpdateRequestLog::getLogVariables

(

)

Returns

array

Implements CirrusSearch\RequestLog.

getRequests()

CirrusSearch\BulkUpdateRequestLog::getRequests

(

)

We could generate multiple items for each bulk update that was sent..but doesn't seem necessary (yet).

Returns

array[]

Implements CirrusSearch\RequestLog.

isCachedResponse()

CirrusSearch\BulkUpdateRequestLog::isCachedResponse

(

)

Returns

bool Was this query answered without talking to elasticsearch?

Implements CirrusSearch\RequestLog.

---

The documentation for this class was generated from the following file:

• includes/BulkUpdateRequestLog.php