CallbackBasedIndexingTaskDruidJobWatcher

Extends \PhpDruidIngest\DruidJobWatcher\IndexingTaskDruidJobWatcher

package

Default

Methods

constructQueryExecutor

constructQueryExecutor( $jobId) : \DruidFamiliar\QueryExecutor\DruidNodeDruidQueryExecutor
inherited

constructQueryGenerator

constructQueryGenerator() : \PhpDruidIngest\QueryGenerator\IndexingTaskStatusQueryGenerator
inherited

constructQueryParameters

constructQueryParameters() : \PhpDruidIngest\QueryParameters\IndexingTaskStatusQueryParameters
inherited

constructQueryResponseHandler

constructQueryResponseHandler() : \PhpDruidIngest\ResponseHandler\IndexingTaskStatusResponseHandler
inherited

Wait to retry watching for a pending job.

doWait( $waitDelay) 
inherited
throws

Arguments

$waitDelay

getDruidIp

getDruidIp() : mixed
inherited

Response

mixed

getDruidPort

getDruidPort() : mixed
inherited

Response

mixed

getOnJobCompleted

getOnJobCompleted() : \Closure

Response

\Closure

getOnJobFailed

getOnJobFailed() : \Closure

Response

\Closure

getOnJobPending

getOnJobPending() : \Closure

Response

\Closure

getOutput

getOutput() : \Psr\Log\LoggerInterface
inherited

Response

\Psr\Log\LoggerInterface

getProtocol

getProtocol() : string
inherited

Response

string

getWatchAttempts

getWatchAttempts() : integer
inherited

Response

integer

handleTaskStatus

handleTaskStatus(\PhpDruidIngest\QueryResponse\IndexingTaskStatusQueryResponse $response) : boolean
inherited
throws

Arguments

Response

boolean

Called when a job's status moves to Completed state.

onJobCompleted() : mixed
inherited

Response

mixed

Called when a job's status moves to a Failed state.

onJobFailed() : mixed
inherited

Response

mixed

Called when a job's status is still in a Running/Pending state after watching period ends.

onJobPending() : mixed
inherited

Response

mixed

Reset watch attempts.

resetWatchAttempts() 
inherited

setDruidIp

setDruidIp(mixed $druidIp) 
inherited

Arguments

$druidIp

mixed

setDruidPort

setDruidPort(mixed $druidPort) 
inherited

Arguments

$druidPort

mixed

setOnJobCompleted

setOnJobCompleted(\Closure $onJobCompleted) 

Arguments

$onJobCompleted

\Closure

setOnJobFailed

setOnJobFailed(\Closure $onJobFailed) 

Arguments

$onJobFailed

\Closure

setOnJobPending

setOnJobPending(\Closure $onJobPending) 

Arguments

$onJobPending

\Closure

setOutput

setOutput(\Psr\Log\LoggerInterface $output) 
inherited

Arguments

$output

\Psr\Log\LoggerInterface

setProtocol

setProtocol(string $protocol) 
inherited

Arguments

$protocol

string

If a job watching can be cancelled, call this to cancel.

stopWatchingJob() : mixed
inherited

Response

mixed

Begin watching given job id.

watchJob(string $jobId) : mixed
inherited

Calls either onJobCompleted or onJobFailed unless stopWatchingJob is called first. If given job is already completed or failed, the appropriate callback will be called.

Arguments

$jobId

string

Response

mixed

Properties

xonJobCompleted

xonJobCompleted : \Closure
var

Type(s)

\Closure

xonJobFailed

xonJobFailed : \Closure
var

Type(s)

\Closure

xonJobPending

xonJobPending : \Closure
var

Type(s)

\Closure

output

output : \Psr\Log\LoggerInterface
inherited
var

Type(s)

\Psr\Log\LoggerInterface

druidIp

druidIp : 
inherited

Type(s)

druidPort

druidPort : 
inherited

Type(s)

protocol

protocol : 
inherited

Type(s)

druidPath

druidPath : 
inherited

Type(s)

druidPathAction

druidPathAction : 
inherited

Type(s)

The current number of watch attempts for the currently running job

watchAttempts : integer
inherited
var

Type(s)

integer

Maximum number of times will attempt to check a status before giving up

maximumWatchAttempts : integer
inherited
var

Type(s)

integer

Delay between task status polling checks.

watchAttemptDelay : integer
inherited
var

seconds waited between polling

Type(s)

integer

Druid Indexing Task Job Id

watchingJobId : string
inherited
var

Type(s)

string