org.apache.tez.client

Class CallerContext

java.lang.Object

org.apache.tez.client.CallerContext

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public class CallerContext
extends Object

Method Summary

Modifier and Type	Method and Description
String	contextAsSimpleString()
static CallerContext	create(String context, String callerId, String callerType, String blob) Instantiate the Caller Context
String	getBlob()
String	getCallerId()
String	getCallerType()
String	getContext()
CallerContext	setBlob(String blob)
CallerContext	setCallerIdAndType(String callerId, String callerType)
CallerContext	setContext(String context)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CallerContext create(String context,
                                   String callerId,
                                   String callerType,
                                   @Nullable
                                   String blob)

Instantiate the Caller Context

Parameters:

context - Context in which Tez is being invoked. For example, HIVE or PIG.

callerId - Caller ID. An ID to uniquely identifier the caller within the callerType namespace

callerType - Type of the caller. Should ideally be used along with callerId to uniquely identify the caller. When used with YARN Timeline, this should map to the Timeline Entity Type. For example, HIVE_QUERY_ID.

blob - Free-form text or a json-representation of relevant meta-data. This can be used to describe the work being done. For example, for Hive, this could be the Hive query text.

Returns:

CallerContext

getCallerType

public String getCallerType()

getCallerId

public String getCallerId()

getBlob

public String getBlob()

getContext

public String getContext()

setContext

public CallerContext setContext(String context)

Parameters:

context - Context in which Tez is being invoked. For example, HIVE or PIG.

setCallerIdAndType

public CallerContext setCallerIdAndType(String callerId,
                                        String callerType)

Parameters:

callerId - Caller ID. An ID to uniquely identifier the caller within the callerType namespace

callerType - Type of the caller. Should ideally be used along with callerId to uniquely identify the caller. When used with YARN Timeline, this should map to the Timeline Entity Type. For example, HIVE_QUERY_ID.

setBlob

public CallerContext setBlob(@Nullable
                             String blob)

Parameters:

blob - Free-form text or a json-representation of relevant meta-data. This can be used to describe the work being done. For example, for Hive, this could be the Hive query text.

toString

public String toString()

Overrides:

toString in class Object

contextAsSimpleString

public String contextAsSimpleString()