ExecutionContext (ODPS SDK UDF 0.36.7-public API)

java.lang.Object
- com.aliyun.odps.udf.ExecutionContext

```
public abstract class ExecutionContext
extends Object
```
运行时的执行上下文信息。
包括UDF所在的StageID，WorkerID等信息。

Constructor Summary

Constructors
Constructor and Description

ExecutionContext()

Constructors
Constructor and Description
`ExecutionContext()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`claimAlive()` 在`UDF`运行期调用此方法防止worker因超时被强制终止。
`int`	`getBackupWorkerID()` 获取当前的backupWorkerID
`abstract Properties`	`getConfigurations()`
`Counter`	`getCounter(Enum<?> name)` 通过`Enum`获取`Counter`
`Counter`	`getCounter(String group, String name)` 通过Group名和Counter名获取`Counter`
`abstract FileSystem`	`getInputVolumeFileSystem()`
`abstract FileSystem`	`getInputVolumeFileSystem(String label)`
`abstract VolumeInfo`	`getInputVolumeInfo()`
`abstract VolumeInfo`	`getInputVolumeInfo(String label)`
`String`	`getInstanceID()` 获取ODPS Instance ID
`abstract FileSystem`	`getOutputVolumeFileSystem()`
`abstract FileSystem`	`getOutputVolumeFileSystem(String label)`
`abstract VolumeInfo`	`getOutputVolumeInfo()`
`abstract VolumeInfo`	`getOutputVolumeInfo(String label)`
`TableRecordReader`	`getResourceTableReader(String resourceName)`
`int`	`getRetryCount()` 获取运行时当前Worker的重试次数
`String`	`getRunningProject()` 获取运行时的Project名
`String`	`getStageID()` 获取运行时StageID
`String`	`getTableInfo()` 获取运行时处理的数据块所属的表或分区信息。
`abstract FileSystem`	`getTempFileSystem()`
`int`	`getWorkerID()` 获取运行时WorkerID
`abstract Iterable<BufferedInputStream>`	`readCacheArchiveAsStream(String resourceName)` 读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
`abstract Iterable<BufferedInputStream>`	`readCacheArchiveAsStream(String resourceName, String relativePath)` 读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
`abstract byte[]`	`readResourceFile(String resourceName)` 读取文件类型资源，一次全部读取到内存，返回 byte[].
`abstract BufferedInputStream`	`readResourceFileAsStream(String resourceName)` 读取文件类型资源，返回一个带缓存的输入流。
`abstract Iterable<Object[]>`	`readResourceTable(String resourceName)` Deprecated.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExecutionContext
```
public ExecutionContext()
```
- Method Detail
  - getInstanceID
```
public String getInstanceID()
```
    获取ODPS Instance ID
  - getStageID
```
public String getStageID()
```
    获取运行时StageID
    
    Returns:
    
    StageID
  - getWorkerID
```
public int getWorkerID()
```
    获取运行时WorkerID
    
    Returns:
    
    WorkerID
  - getRunningProject
```
public String getRunningProject()
```
    获取运行时的Project名
    
    Returns:
    
    Running project name
  - getRetryCount
```
public int getRetryCount()
```
    获取运行时当前Worker的重试次数
    
    Returns:
    
    当前Worker的重试次数，0代表还没有发生重试，当获取重试次数失败时，返回-1
  - getBackupWorkerID
```
public int getBackupWorkerID()
```
    获取当前的backupWorkerID
    
    Returns:
    
    如果当前worker不是backupWorker，返回0；否则返回当前的backupWorkerID；获取失败返回-1
  - getTableInfo
```
public String getTableInfo()
```
    获取运行时处理的数据块所属的表或分区信息。
    
    Returns:
    
    非分区表返回："项目名.表名"。分区表返回："项目名.表名/分区名=分区值"。如果有多级分区，按照分区结构返回相应的目录结构。
    
    Throws:
    
    当UDF运行在非Map端时，调用此方法会抛出 - InvalidInvocationException 异常。
  - claimAlive
```
public abstract void claimAlive()
```
    在UDF运行期调用此方法防止worker因超时被强制终止。
    UDF在运行期每一次调用(UDF#evaluate()、UDTF.process(Object[])等方法) 最多能消耗的时间有一定限制，当超出这个限制时，worker会被强制终止。当UDF涉及计算密集型的任务时，可能一次调用需要消耗更多时间，调用此方法可以重置时间限制，防止被提前终止。
  - getCounter
```
public Counter getCounter(Enum<?> name)
```
    通过Enum获取Counter
    等价于调用
```
 
 getCounter(name.getDeclaringClass().getName(), name.toString())
 
 
```
    Parameters:
    
    name - Counter标识
    
    Returns:
    
    对应标识的Counter对象
    
    Throws:
    
    IllegalArgumentException - - name 不能为null
    
    See Also:
    
    getCounter(String, String)
  - getCounter
```
public Counter getCounter(String group,
                          String name)
```
    通过Group名和Counter名获取Counter
    Counter信息最后会汇总在SQL Task的Summary中。
    Parameters:
    
    group - Group标识
    
    name - Counter标识
    
    Returns:
    
    对应标识的Counter对象
    
    Throws:
    IllegalArgumentException - Group名和Counter名中不能
    
    为null
    
    为空字符串
    
    包含'#'字符
    
    加起来字符串长度超过64字节
    
    当所定义Counter数量超过100个时也会抛出异常
  - readResourceFileAsStream
```
public abstract BufferedInputStream readResourceFileAsStream(String resourceName)
                                                      throws IOException
```
    读取文件类型资源，返回一个带缓存的输入流。
    readResourceFileAsStream(String) 该方法支持边读边处理（常见的场景是读取一行处理一行），适合读取比较大的文件资源，防止Java内存溢出，如果文件资源比较小，也可以直接使用。
    readResourceFile(String) 方法会把内容一次性读取到内存。
    
    Parameters:
    
    resourceName - 资源名称
    
    Returns:
    
    资源内容的BufferedInputStream
    
    Throws:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    See Also:
    
    readResourceFile(String)
  - readResourceFile
```
public abstract byte[] readResourceFile(String resourceName)
                                 throws IOException
```
    读取文件类型资源，一次全部读取到内存，返回 byte[].
    如果资源文件比较大，应该使用readResourceFileAsStream(String) 获得一个带缓存的输入流，支持边读边处理，防止Java内存溢出。
    
    Parameters:
    
    resourceName - 资源名称
    
    Returns:
    
    资源内容
    
    Throws:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    See Also:
    
    readResourceFileAsStream(String)
  - readResourceTable
```
@Deprecated
public abstract Iterable<Object[]> readResourceTable(String resourceName)
                                                          throws IOException
```
    Deprecated.
    
    读取表类型资源，返回Iterable，Object为对应表每一列的Java原生类型.
    
    Parameters:
    
    resourceName - 资源名称
    
    Returns:
    
    Iterable
    
    Throws:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
  - getResourceTableReader
```
public TableRecordReader getResourceTableReader(String resourceName)
                                         throws IOException
```
    Throws:
    
    IOException
  - readCacheArchiveAsStream
```
public abstract Iterable<BufferedInputStream> readCacheArchiveAsStream(String resourceName)
                                                                throws IOException
```
    读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
    
    Parameters:
    
    resourceName - 资源名称
    
    Returns:
    
    BufferedInputStream的迭代器
    
    Throws:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
  - readCacheArchiveAsStream
```
public abstract Iterable<BufferedInputStream> readCacheArchiveAsStream(String resourceName,
                                                                       String relativePath)
                                                                throws IOException
```
    读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
    
    Parameters:
    
    resourceName - 资源名称
    
    relativePath - 读取资源的相对路径
    
    Returns:
    
    BufferedInputStream的迭代器
    
    Throws:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
  - getInputVolumeInfo
```
public abstract VolumeInfo getInputVolumeInfo()
                                       throws IOException
```
    Throws:
    
    IOException
  - getInputVolumeInfo
```
public abstract VolumeInfo getInputVolumeInfo(String label)
                                       throws IOException
```
    Throws:
    
    IOException
  - getOutputVolumeInfo
```
public abstract VolumeInfo getOutputVolumeInfo()
                                        throws IOException
```
    Throws:
    
    IOException
  - getOutputVolumeInfo
```
public abstract VolumeInfo getOutputVolumeInfo(String label)
                                        throws IOException
```
    Throws:
    
    IOException
  - getInputVolumeFileSystem
```
public abstract FileSystem getInputVolumeFileSystem()
                                             throws IOException
```
    Throws:
    
    IOException
  - getInputVolumeFileSystem
```
public abstract FileSystem getInputVolumeFileSystem(String label)
                                             throws IOException
```
    Throws:
    
    IOException
  - getOutputVolumeFileSystem
```
public abstract FileSystem getOutputVolumeFileSystem()
                                              throws IOException
```
    Throws:
    
    IOException
  - getOutputVolumeFileSystem
```
public abstract FileSystem getOutputVolumeFileSystem(String label)
                                              throws IOException
```
    Throws:
    
    IOException
  - getConfigurations
```
public abstract Properties getConfigurations()
```
  - getTempFileSystem
```
public abstract FileSystem getTempFileSystem()
                                      throws IOException
```
    Throws:
    
    IOException

Class ExecutionContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExecutionContext

Method Detail

getInstanceID

getStageID

getWorkerID

getRunningProject

getRetryCount

getBackupWorkerID

getTableInfo

claimAlive

getCounter

getCounter

readResourceFileAsStream

readResourceFile

readResourceTable

getResourceTableReader

readCacheArchiveAsStream

readCacheArchiveAsStream

getInputVolumeInfo

getInputVolumeInfo

getOutputVolumeInfo

getOutputVolumeInfo

getInputVolumeFileSystem

getInputVolumeFileSystem

getOutputVolumeFileSystem

getOutputVolumeFileSystem

getConfigurations

getTempFileSystem