org.apache.tez.dag.api.client

Class DAGClientImpl

java.lang.Object

org.apache.tez.dag.api.client.DAGClient

org.apache.tez.dag.api.client.DAGClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
public class DAGClientImpl
extends DAGClient

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isATSEnabled
protected DAGClientInternal	realClient

Constructor Summary

Constructors

Constructor and Description
DAGClientImpl(org.apache.hadoop.yarn.api.records.ApplicationId appId, String dagId, TezConfiguration conf, FrameworkClient frameworkClient, org.apache.hadoop.security.UserGroupInformation ugi)

Method Summary

Modifier and Type	Method and Description
void	close()
protected org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReportInternal()
String	getDagIdentifierString() Get the dag identifier for the currently executing dag.
DAGStatus	getDAGStatus(Set<StatusGetOpts> statusOptions) Get the status of the specified DAG
DAGStatus	getDAGStatus(Set<StatusGetOpts> statusOptions, long timeout) Get the status of the specified DAG when it reaches a final state, or the timeout expires.
protected DAGStatus	getDAGStatusViaRM() Get the DAG status via the YARN ResourceManager
String	getExecutionContext() Gets DAG execution context for use with logging
DAGClientInternal	getRealClient()
String	getSessionIdentifierString() Get the session identifier for the session in which this dag is running
VertexStatus	getVertexStatus(String vertexName, Set<StatusGetOpts> statusOptions) Get the status of a Vertex of a DAG
void	tryKillDAG() Kill a running DAG
DAGStatus	waitForCompletion() Wait forever for DAG to complete without printing any vertex statuses
DAGStatus	waitForCompletion(long timeMs) Wait for DAG to complete without printing any vertex statuses
DAGStatus	waitForCompletionWithStatusUpdates(Set<StatusGetOpts> statusGetOpts) Wait for DAG to complete and periodically print *all* vertices' status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

realClient

protected DAGClientInternal realClient

isATSEnabled

protected boolean isATSEnabled

Constructor Detail

DAGClientImpl

public DAGClientImpl(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                     String dagId,
                     TezConfiguration conf,
                     @Nullable
                     FrameworkClient frameworkClient,
                     org.apache.hadoop.security.UserGroupInformation ugi)

Method Detail

getExecutionContext

public String getExecutionContext()

Description copied from class: DAGClient

Gets DAG execution context for use with logging

Specified by:

getExecutionContext in class DAGClient

Returns:

summary of DAG execution

getApplicationReportInternal

protected org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReportInternal()

Specified by:

getApplicationReportInternal in class DAGClient

getDAGStatus

public DAGStatus getDAGStatus(@Nullable
                              Set<StatusGetOpts> statusOptions,
                              long timeout)
                       throws TezException,
                              IOException

Description copied from class: DAGClient

Get the status of the specified DAG when it reaches a final state, or the timeout expires.

Specified by:

getDAGStatus in class DAGClient

Parameters:

statusOptions - Optionally, retrieve additional information based on specified options. To retrieve basic information, this can be null

timeout - RPC call timeout. Value -1 waits for infinite and returns when DAG reaches final state

Returns:

DAG Status

Throws:

TezException

IOException

getDAGStatus

public DAGStatus getDAGStatus(@Nullable
                              Set<StatusGetOpts> statusOptions)
                       throws TezException,
                              IOException

Description copied from class: DAGClient

Get the status of the specified DAG

Specified by:

getDAGStatus in class DAGClient

Parameters:

statusOptions - Optionally, retrieve additional information based on specified options. To retrieve basic information, this can be null

Throws:

TezException

IOException

getVertexStatus

public VertexStatus getVertexStatus(String vertexName,
                                    Set<StatusGetOpts> statusOptions)
                             throws IOException,
                                    TezException

Description copied from class: DAGClient

Get the status of a Vertex of a DAG

Specified by:

getVertexStatus in class DAGClient

statusOptions - Optionally, retrieve additional information based on specified options

Throws:

IOException

TezException

getDagIdentifierString

public String getDagIdentifierString()

Description copied from class: DAGClient

Get the dag identifier for the currently executing dag. This is a string which represents this dag

Specified by:

getDagIdentifierString in class DAGClient

Returns:

the dag identifier

getSessionIdentifierString

public String getSessionIdentifierString()

Description copied from class: DAGClient

Get the session identifier for the session in which this dag is running

Specified by:

getSessionIdentifierString in class DAGClient

Returns:

the session identifier

tryKillDAG

public void tryKillDAG()
                throws IOException,
                       TezException

Description copied from class: DAGClient

Kill a running DAG

Specified by:

tryKillDAG in class DAGClient

Throws:

IOException

TezException

waitForCompletion

public DAGStatus waitForCompletion(long timeMs)
                            throws IOException,
                                   TezException,
                                   InterruptedException

Description copied from class: DAGClient

Wait for DAG to complete without printing any vertex statuses

Overrides:

waitForCompletion in class DAGClient

Parameters:

timeMs - Maximum wait duration

Returns:

Final DAG Status, or null on timeout or if DAG is no longer running

Throws:

IOException

TezException

InterruptedException

waitForCompletion

public DAGStatus waitForCompletion()
                            throws IOException,
                                   TezException,
                                   InterruptedException

Description copied from class: DAGClient

Wait forever for DAG to complete without printing any vertex statuses

Specified by:

waitForCompletion in class DAGClient

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

waitForCompletionWithStatusUpdates

public DAGStatus waitForCompletionWithStatusUpdates(@Nullable
                                                    Set<StatusGetOpts> statusGetOpts)
                                             throws IOException,
                                                    TezException,
                                                    InterruptedException

Description copied from class: DAGClient

Wait for DAG to complete and periodically print *all* vertices' status.

Specified by:

waitForCompletionWithStatusUpdates in class DAGClient

Parameters:

statusGetOpts - : status get options. For example, to get counter pass EnumSet.of(StatusGetOpts.GET_COUNTERS)

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

close

public void close()
           throws IOException

Throws:

IOException

getDAGStatusViaRM

protected DAGStatus getDAGStatusViaRM()
                               throws TezException,
                                      IOException

Get the DAG status via the YARN ResourceManager

Returns:

the dag status, inferred from the RM App state. Does not return null.

Throws:

TezException

IOException

getRealClient

public DAGClientInternal getRealClient()