@InterfaceAudience.Public public abstract class DAGClient extends Object implements Closeable
DAG
running in a Tez DAG
Application Master.Constructor and Description |
---|
DAGClient() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getDagIdentifierString()
Get the dag identifier for the currently executing dag.
|
abstract DAGStatus |
getDAGStatus(Set<StatusGetOpts> statusOptions)
Get the status of the specified DAG
|
abstract DAGStatus |
getDAGStatus(Set<StatusGetOpts> statusOptions,
long timeout)
Get the status of the specified DAG when it reaches a final state, or the timeout expires.
|
abstract String |
getExecutionContext()
Gets DAG execution context for use with logging
|
abstract String |
getSessionIdentifierString()
Get the session identifier for the session in which this dag is running
|
abstract VertexStatus |
getVertexStatus(String vertexName,
Set<StatusGetOpts> statusOptions)
Get the status of a Vertex of a DAG
|
abstract String |
getWebUIAddress()
Returns the Tez AM's web ui address if any.
|
abstract void |
tryKillDAG()
Kill a running DAG
|
abstract 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
|
abstract DAGStatus |
waitForCompletionWithStatusUpdates(Set<StatusGetOpts> statusGetOpts)
Wait for DAG to complete and periodically print *all* vertices' status.
|
public abstract String getExecutionContext()
public abstract DAGStatus getDAGStatus(@Nullable Set<StatusGetOpts> statusOptions) throws IOException, TezException
statusOptions
- Optionally, retrieve additional information based on
specified options. To retrieve basic information, this can be nullIOException
TezException
public abstract DAGStatus getDAGStatus(@Nullable Set<StatusGetOpts> statusOptions, long timeout) throws IOException, TezException
statusOptions
- Optionally, retrieve additional information based on
specified options. To retrieve basic information, this can be nulltimeout
- RPC call timeout. Value -1 waits for infinite and returns when
DAG reaches final stateIOException
TezException
public abstract VertexStatus getVertexStatus(String vertexName, Set<StatusGetOpts> statusOptions) throws IOException, TezException
statusOptions
- Optionally, retrieve additional information based on
specified optionsIOException
TezException
public abstract String getDagIdentifierString()
public abstract String getSessionIdentifierString()
public abstract void tryKillDAG() throws IOException, TezException
IOException
TezException
public abstract DAGStatus waitForCompletion() throws IOException, TezException, InterruptedException
IOException
TezException
InterruptedException
public DAGStatus waitForCompletion(long timeMs) throws IOException, TezException, InterruptedException
timeMs
- Maximum wait durationIOException
TezException
InterruptedException
public abstract DAGStatus waitForCompletionWithStatusUpdates(@Nullable Set<StatusGetOpts> statusGetOpts) throws IOException, TezException, InterruptedException
statusGetOpts
- : status get options. For example, to get counter pass
EnumSet.of(StatusGetOpts.GET_COUNTERS)
IOException
TezException
InterruptedException
public abstract String getWebUIAddress() throws IOException, TezException
IOException
TezException
Copyright © 2024 Apache Software Foundation. All rights reserved.