org.apache.pig.tools.pigstats

Interface PigProgressNotificationListener

All Superinterfaces:

java.util.EventListener

All Known Implementing Classes:

PigTezProgressNotificationListener

@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface PigProgressNotificationListener
extends java.util.EventListener

Should be implemented by an object that wants to receive notifications from PigRunner.

Method Summary

Methods

Modifier and Type	Method and Description
void	initialPlanNotification(java.lang.String scriptId, OperatorPlan<?> plan) Invoked before any Hadoop jobs (or a Tez DAG) are run with the plan that is to be executed.
void	jobFailedNotification(java.lang.String scriptId, JobStats jobStats) Invoked when a Hadoop job fails.
void	jobFinishedNotification(java.lang.String scriptId, JobStats jobStats) Invoked just after a Hadoop job (or Tez DAG) is completed successfully.
void	jobsSubmittedNotification(java.lang.String scriptId, int numJobsSubmitted) Invoked just before submitting a batch of Hadoop jobs (or Tez DAGs).
void	jobStartedNotification(java.lang.String scriptId, java.lang.String assignedJobId) Invoked after a Hadoop job (or Tez DAG) is started.
void	launchCompletedNotification(java.lang.String scriptId, int numJobsSucceeded) Invoked just after all Hadoop jobs (Tez DAGs) spawned by the script are completed.
void	launchStartedNotification(java.lang.String scriptId, int numJobsToLaunch) Invoked just before launching Hadoop jobs (or tez DAGs) spawned by the script.
void	outputCompletedNotification(java.lang.String scriptId, OutputStats outputStats) Invoked just after an output is successfully written.
void	progressUpdatedNotification(java.lang.String scriptId, int progress) Invoked to update the execution progress.

Method Detail

initialPlanNotification

void initialPlanNotification(java.lang.String scriptId,
                           OperatorPlan<?> plan)

Invoked before any Hadoop jobs (or a Tez DAG) are run with the plan that is to be executed.

Parameters:

scriptId - the unique id of the script

plan - the OperatorPlan that is to be executed

launchStartedNotification

void launchStartedNotification(java.lang.String scriptId,
                             int numJobsToLaunch)

Invoked just before launching Hadoop jobs (or tez DAGs) spawned by the script.

Parameters:

scriptId - the unique id of the script

numJobsToLaunch - the total number of Hadoop jobs (or Tez DAGs) spawned by the script

jobsSubmittedNotification

void jobsSubmittedNotification(java.lang.String scriptId,
                             int numJobsSubmitted)

Invoked just before submitting a batch of Hadoop jobs (or Tez DAGs).

Parameters:

scriptId - the unique id of the script

numJobsSubmitted - the number of Hadoop jobs (or Tez DAGs) in the batch

jobStartedNotification

void jobStartedNotification(java.lang.String scriptId,
                          java.lang.String assignedJobId)

Invoked after a Hadoop job (or Tez DAG) is started.

Parameters:

scriptId - the unique id of the script

assignedJobId - the Hadoop job id (or Tez DAG job id)

jobFinishedNotification

void jobFinishedNotification(java.lang.String scriptId,
                           JobStats jobStats)

Invoked just after a Hadoop job (or Tez DAG) is completed successfully.

Parameters:

scriptId - the unique id of the script

jobStats - the JobStats object associated with the Hadoop job (or Tez DAG)

jobFailedNotification

void jobFailedNotification(java.lang.String scriptId,
                         JobStats jobStats)

Invoked when a Hadoop job fails.

Parameters:

scriptId - the unique id of the script

jobStats - the JobStats object associated with the Hadoop job

outputCompletedNotification

void outputCompletedNotification(java.lang.String scriptId,
                               OutputStats outputStats)

Invoked just after an output is successfully written.

Parameters:

scriptId - the unique id of the script

outputStats - the OutputStats object associated with the output

progressUpdatedNotification

void progressUpdatedNotification(java.lang.String scriptId,
                               int progress)

Invoked to update the execution progress.

Parameters:

scriptId - the unique id of the script

progress - the percentage of the execution progress

launchCompletedNotification

void launchCompletedNotification(java.lang.String scriptId,
                               int numJobsSucceeded)

Invoked just after all Hadoop jobs (Tez DAGs) spawned by the script are completed.

Parameters:

scriptId - the unique id of the script

numJobsSucceeded - the total number of Hadoop jobs (Tez DAGs) succeeded