ExecutionContext (ODPS SDK UDF 0.17.3 API)

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

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

构造器概要

构造器
构造器和说明

ExecutionContext()

构造器
构造器和说明
`ExecutionContext()`

方法概要

方法
限定符和类型	方法和说明
`abstract void`	`claimAlive()` 在`UDF`运行期调用此方法防止worker因超时被强制终止。
`Counter`	`getCounter(Enum<?> name)` 通过`Enum`获取`Counter` 等价于调用 `getCounter(name.getDeclaringClass().getName(), name.toString())`
`Counter`	`getCounter(String group, String name)` 通过Group名和Counter名获取`Counter` `Counter`信息最后会汇总在SQL Task的Summary中。
`abstract FileSystem`	`getInputVolumeFileSystem()`
`abstract FileSystem`	`getInputVolumeFileSystem(String label)`
`abstract VolumeInfo`	`getInputVolumeInfo()`
`abstract VolumeInfo`	`getInputVolumeInfo(String label)`
`abstract FileSystem`	`getOutputVolumeFileSystem()`
`abstract FileSystem`	`getOutputVolumeFileSystem(String label)`
`abstract VolumeInfo`	`getOutputVolumeInfo()`
`abstract VolumeInfo`	`getOutputVolumeInfo(String label)`
`String`	`getStageID()` 获取运行时StageID
`String`	`getTableInfo()` 获取运行时处理的数据块所属的表或分区信息。
`int`	`getWorkerID()` 获取运行时WorkerID
`abstract byte[]`	`readResourceFile(String resourceName)` 读取文件类型资源，一次全部读取到内存，返回 byte[].
`abstract BufferedInputStream`	`readResourceFileAsStream(String resourceName)` 读取文件类型资源，返回一个带缓存的输入流。
`abstract Iterable<Object[]>`	`readResourceTable(String resourceName)` 读取表类型资源，返回Iterable，Object为对应表每一列的Java原生类型.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ExecutionContext
```
public ExecutionContext()
```
- 方法详细资料
  - getStageID
```
public String getStageID()
```
    获取运行时StageID
    
    返回:
    StageID
  - getWorkerID
```
public int getWorkerID()
```
    获取运行时WorkerID
    
    返回:
    WorkerID
  - getTableInfo
```
public String getTableInfo()
```
    获取运行时处理的数据块所属的表或分区信息。
    
    返回:
    非分区表返回："项目名.表名"。分区表返回："项目名.表名/分区名=分区值"。如果有多级分区，按照分区结构返回相应的目录结构。
    
    抛出:
    
    当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())
 
 
```
    参数:
    name - Counter标识
    
    返回:
    对应标识的Counter对象
    
    抛出:
    
    IllegalArgumentException - - name 不能为null
    另请参阅:
    getCounter(String, String)
  - getCounter
```
public Counter getCounter(String group,
                 String name)
```
    通过Group名和Counter名获取Counter
    Counter信息最后会汇总在SQL Task的Summary中。
    参数:
    group - Group标识
    name - Counter标识
    
    返回:
    对应标识的Counter对象
    
    抛出:
    IllegalArgumentException - Group名和Counter名中不能
    
    为null
    
    为空字符串
    
    包含'#'字符
    
    加起来字符串长度超过64字节
    
    当所定义Counter数量超过100个时也会抛出异常
  - readResourceFileAsStream
```
public abstract BufferedInputStream readResourceFileAsStream(String resourceName)
                                                      throws IOException
```
    读取文件类型资源，返回一个带缓存的输入流。
    readResourceFileAsStream(String) 该方法支持边读边处理（常见的场景是读取一行处理一行），适合读取比较大的文件资源，防止Java内存溢出，如果文件资源比较小，也可以直接使用。
    readResourceFile(String) 方法会把内容一次性读取到内存。
    
    参数:
    resourceName - 资源名称
    
    返回:
    资源内容的BufferedInputStream
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    另请参阅:
    readResourceFile(String)
  - readResourceFile
```
public abstract byte[] readResourceFile(String resourceName)
                                 throws IOException
```
    读取文件类型资源，一次全部读取到内存，返回 byte[].
    如果资源文件比较大，应该使用readResourceFileAsStream(String) 获得一个带缓存的输入流，支持边读边处理，防止Java内存溢出。
    
    参数:
    resourceName - 资源名称
    
    返回:
    资源内容
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    另请参阅:
    readResourceFileAsStream(String)
  - readResourceTable
```
public abstract Iterable<Object[]> readResourceTable(String resourceName)
                                              throws IOException
```
    读取表类型资源，返回Iterable，Object为对应表每一列的Java原生类型.
    
    参数:
    resourceName - 资源名称
    
    返回:
    Iterable
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
  - getInputVolumeInfo
```
public abstract VolumeInfo getInputVolumeInfo()
                                       throws IOException
```
    抛出:
    
    IOException
  - getInputVolumeInfo
```
public abstract VolumeInfo getInputVolumeInfo(String label)
                                       throws IOException
```
    抛出:
    
    IOException
  - getOutputVolumeInfo
```
public abstract VolumeInfo getOutputVolumeInfo()
                                        throws IOException
```
    抛出:
    
    IOException
  - getOutputVolumeInfo
```
public abstract VolumeInfo getOutputVolumeInfo(String label)
                                        throws IOException
```
    抛出:
    
    IOException
  - getInputVolumeFileSystem
```
public abstract FileSystem getInputVolumeFileSystem()
                                             throws IOException
```
    抛出:
    
    IOException
  - getInputVolumeFileSystem
```
public abstract FileSystem getInputVolumeFileSystem(String label)
                                             throws IOException
```
    抛出:
    
    IOException
  - getOutputVolumeFileSystem
```
public abstract FileSystem getOutputVolumeFileSystem()
                                              throws IOException
```
    抛出:
    
    IOException
  - getOutputVolumeFileSystem
```
public abstract FileSystem getOutputVolumeFileSystem(String label)
                                              throws IOException
```
    抛出:
    
    IOException

类 ExecutionContext

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ExecutionContext

方法详细资料

getStageID

getWorkerID

getTableInfo

claimAlive

getCounter

getCounter

readResourceFileAsStream

readResourceFile

readResourceTable

getInputVolumeInfo

getInputVolumeInfo

getOutputVolumeInfo

getOutputVolumeInfo

getInputVolumeFileSystem

getInputVolumeFileSystem

getOutputVolumeFileSystem

getOutputVolumeFileSystem