org.apache.tez.dag.api.client.rpc

Class DAGClientRPCImpl

java.lang.Object

org.apache.tez.dag.api.client.DAGClientInternal

org.apache.tez.dag.api.client.rpc.DAGClientRPCImpl

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
public class DAGClientRPCImpl
extends DAGClientInternal

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReportInternal()
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.
String	getExecutionContext() Gets DAG execution context for use with logging
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 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

Constructor Detail

DAGClientRPCImpl

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

Method Detail

getExecutionContext

public String getExecutionContext()

Description copied from class: DAGClientInternal

Gets DAG execution context for use with logging

Specified by:

getExecutionContext in class DAGClientInternal

Returns:

summary of DAG execution

getDAGStatus

public DAGStatus getDAGStatus(Set<StatusGetOpts> statusOptions)
                       throws IOException,
                              TezException,
                              org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException

Description copied from class: DAGClientInternal

Get the status of the specified DAG

Specified by:

getDAGStatus in class DAGClientInternal

Parameters:

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

Throws:

IOException

TezException

org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException

getDAGStatus

public DAGStatus getDAGStatus(@Nullable
                     Set<StatusGetOpts> statusOptions,
                     long timeout)
                       throws IOException,
                              TezException,
                              org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException

Description copied from class: DAGClientInternal

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

Specified by:

getDAGStatus in class DAGClientInternal

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:

IOException

TezException

org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException

getVertexStatus

public VertexStatus getVertexStatus(String vertexName,
                           Set<StatusGetOpts> statusOptions)
                             throws IOException,
                                    TezException,
                                    org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException

Description copied from class: DAGClientInternal

Get the status of a Vertex of a DAG

Specified by:

getVertexStatus in class DAGClientInternal

statusOptions - Optionally, retrieve additional information based on specified options

Throws:

IOException

TezException

org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException

tryKillDAG

public void tryKillDAG()
                throws TezException,
                       IOException

Description copied from class: DAGClientInternal

Kill a running DAG

Specified by:

tryKillDAG in class DAGClientInternal

Throws:

TezException

IOException

close

public void close()
           throws IOException

Throws:

IOException

getApplicationReportInternal

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

Specified by:

getApplicationReportInternal in class DAGClientInternal

waitForCompletion

public DAGStatus waitForCompletion()
                            throws IOException,
                                   TezException,
                                   InterruptedException

Description copied from class: DAGClientInternal

Wait for DAG to complete without printing any vertex statuses

Specified by:

waitForCompletion in class DAGClientInternal

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

waitForCompletionWithStatusUpdates

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

Description copied from class: DAGClientInternal

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

Specified by:

waitForCompletionWithStatusUpdates in class DAGClientInternal

Parameters:

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

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException