Instance (ODPS SDK Core 0.17.3 API)

java.lang.Object
- com.aliyun.odps.LazyLoad
- - com.aliyun.odps.Instance

```
public class Instance
extends LazyLoad
```
Instance表示ODPS中计算任务的一个运行实例

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`Instance.Result`
`static class`	`Instance.StageProgress` StageProgress表示`Task`执行过程中各阶段的进度统计
`static class`	`Instance.Status` Instance的运行状态。
`static class`	`Instance.TaskStatus` Task执行状态
`static class`	`Instance.TaskSummary` TaskSummary包含`Task`运行结束后的汇总信息 Summary信息以key-value对的形式组织

方法概要

方法
限定符和类型	方法和说明
`Date`	`getEndTime()` 获得Instance结束执行时间
`String`	`getId()` 获得Instance的ID
`String`	`getLog(String workerId, LogType logType, int size)` 获取Worker运行的LOG内容
`OdpsHooks`	`getOdpsHooks()`
`String`	`getOwner()` 获得Instance所属用户
`int`	`getPriority()` 获取 Instance 的优先级
`String`	`getProject()` 获得Instance所属`Project`名称
`Date`	`getStartTime()` 获得Instance开始执行时间
`Instance.Status`	`getStatus()` 获得Instance状态 Instance状态如下: RUNNING: 正在执行 SUSPENDED: 被挂起 TERMINATED: 执行结束, 包括成功、失败、取消等
`String`	`getTaskDetailJson(String taskName)`
`String`	`getTaskDetailJson2(String taskName)`
`Set<String>`	`getTaskNames()` 获得Instance所包含的所有`Task`的名称
`List<Instance.StageProgress>`	`getTaskProgress(String taskName)` 查询指定Task的Stage进度
`Map<String,String>`	`getTaskResults()` 获得Instance中Task的运行结果
`Map<String,Instance.Result>`	`getTaskResultsWithFormat()` 获得Instance中`Task`的运行结果
`List<Task>`	`getTasks()` 返回与作业运行实例相关的作业`Task`实例。
`Map<String,Instance.TaskStatus>`	`getTaskStatus()` 查询Instance中所有`Task`的执行状态
`Instance.TaskSummary`	`getTaskSummary(String taskName)` 获得Instance中Task的运行汇总信息当 Server 端返回信息，但是信息格式错误时，返回 null
`boolean`	`isHookInvoked()`
`boolean`	`isSuccessful()` 检查`Instance`是否执行成功成功的含义为Instance执行结束,并且所有Task的状态为成功
`boolean`	`isSync()` 获得Instance是否为同步执行
`boolean`	`isTerminated()` 检查是否执行完成
`void`	`reload()` 重新加载属性值
`void`	`setHookInvoked(boolean hookInvoked)`
`void`	`setOdpsHooks(OdpsHooks hooks)`
`void`	`stop()` 停止正在执行的Instance
`void`	`waitForSuccess()` 阻塞当前线程, 直到Instance结束
`void`	`waitForSuccess(long interval)` 阻塞当前线程, 直到Instance结束

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

- 方法详细资料
  - reload
```
public void reload()
            throws OdpsException
```
    从类复制的说明: LazyLoad
    
    重新加载属性值
    
    指定者:
    
    reload 在类中 LazyLoad
    
    抛出:
    
    OdpsException
  - stop
```
public void stop()
          throws OdpsException
```
    停止正在执行的Instance
    
    抛出:
    
    OdpsException
  - getTaskResultsWithFormat
```
public Map<String,Instance.Result> getTaskResultsWithFormat()
                                                     throws OdpsException
```
    获得Instance中Task的运行结果
    
    返回:
    Task的运行结果, key为Task的名称，value为Instance.Result
    
    抛出:
    
    OdpsException
  - getTaskResults
```
public Map<String,String> getTaskResults()
                                  throws OdpsException
```
    获得Instance中Task的运行结果
    
    返回:
    Task的运行结果, key为Task的名称，value为Instance.Result .getString()的结果。
    
    抛出:
    
    OdpsException
  - getTaskSummary
```
public Instance.TaskSummary getTaskSummary(String taskName)
                                    throws OdpsException
```
    获得Instance中Task的运行汇总信息当 Server 端返回信息，但是信息格式错误时，返回 null
    
    参数:
    taskName - 指定的TaskName
    
    返回:
    汇总信息 Instance.TaskSummary
    
    抛出:
    
    OdpsException
  - getTaskStatus
```
public Map<String,Instance.TaskStatus> getTaskStatus()
                                              throws OdpsException
```
    查询Instance中所有Task的执行状态
    
    返回:
    Map, key为Task名称, value为表示Task执行状态的Instance.TaskStatus对象
    
    抛出:
    
    OdpsException
  - getTaskNames
```
public Set<String> getTaskNames()
                         throws OdpsException
```
    获得Instance所包含的所有Task的名称
    
    返回:
    Task的名称集合
    
    抛出:
    
    OdpsException
  - isSuccessful
```
public boolean isSuccessful()
                     throws OdpsException
```
    检查Instance是否执行成功
    成功的含义为Instance执行结束,并且所有Task的状态为成功
    
    返回:
    true如果成功
    
    抛出:
    
    OdpsException
  - waitForSuccess
```
public void waitForSuccess()
                    throws OdpsException
```
    阻塞当前线程, 直到Instance结束
    
    抛出:
    
    OdpsException - Instance失败
  - waitForSuccess
```
public void waitForSuccess(long interval)
                    throws OdpsException
```
    阻塞当前线程, 直到Instance结束
    
    参数:
    interval - 内部轮询间隔
    
    抛出:
    
    OdpsException - Instance失败
  - getTaskProgress
```
public List<Instance.StageProgress> getTaskProgress(String taskName)
                                             throws OdpsException
```
    查询指定Task的Stage进度
    
    参数:
    taskName - Task名称
    
    返回:
    Instance.StageProgress列表
    
    抛出:
    
    OdpsException
  - getId
```
public String getId()
```
    获得Instance的ID
    
    返回:
    Instance ID
  - getStatus
```
public Instance.Status getStatus()
```
    获得Instance状态
    Instance状态如下:
    - RUNNING: 正在执行
    - SUSPENDED: 被挂起
    - TERMINATED: 执行结束, 包括成功、失败、取消等
    返回:
    返回Status.TERMINATED
  - isTerminated
```
public boolean isTerminated()
```
    检查是否执行完成
    
    返回:
    TERMINATED状态返回true, 否则返回false
  - getProject
```
public String getProject()
```
    获得Instance所属Project名称
    
    返回:
    Project名称
  - isSync
```
public boolean isSync()
```
    获得Instance是否为同步执行
    
    返回:
    true如果同步执行
  - getOwner
```
public String getOwner()
```
    获得Instance所属用户
    
    返回:
    用户名
  - getStartTime
```
public Date getStartTime()
```
    获得Instance开始执行时间
    
    返回:
    开始执行时间
  - getEndTime
```
public Date getEndTime()
```
    获得Instance结束执行时间
    
    返回:
    结束执行时间
  - getTasks
```
public List<Task> getTasks()
                    throws OdpsException
```
    返回与作业运行实例相关的作业Task实例。
    
    返回:
    与作业运行实例相关的作业Task实例。
    
    抛出:
    
    OdpsException
  - getPriority
```
public int getPriority()
                throws OdpsException
```
    获取 Instance 的优先级
    
    返回:
    
    抛出:
    
    OdpsException
  - getLog
```
public String getLog(String workerId,
            LogType logType,
            int size)
              throws OdpsException
```
    获取Worker运行的LOG内容
    
    参数:
    workerId - Worker ID，Task 内Worker的唯一标示。
    logType - LogType 对象
    size - 展示Log内容的长度
    
    返回:
    Log内容
    
    抛出:
    
    OdpsException
    
    IOException
  - getTaskDetailJson
```
public String getTaskDetailJson(String taskName)
                         throws OdpsException
```
    抛出:
    
    OdpsException
  - getOdpsHooks
```
public OdpsHooks getOdpsHooks()
```
  - setOdpsHooks
```
public void setOdpsHooks(OdpsHooks hooks)
```
  - isHookInvoked
```
public boolean isHookInvoked()
```
  - setHookInvoked
```
public void setHookInvoked(boolean hookInvoked)
```
  - getTaskDetailJson2
```
public String getTaskDetailJson2(String taskName)
                          throws OdpsException
```
    抛出:
    
    OdpsException

类 Instance

嵌套类概要

方法概要

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

方法详细资料

reload

stop

getTaskResultsWithFormat

getTaskResults

getTaskSummary

getTaskStatus

getTaskNames

isSuccessful

waitForSuccess

waitForSuccess

getTaskProgress

getId

getStatus

isTerminated

getProject

isSync

getOwner

getStartTime

getEndTime

getTasks

getPriority

getLog

getTaskDetailJson

getOdpsHooks

setOdpsHooks

isHookInvoked

setHookInvoked

getTaskDetailJson2