Instance (ODPS SDK Core 0.51.0-public.rc1 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Instance.InstanceQueueingInfo`
`static class`	`Instance.InstanceResultModel` 表示Instance运行结果的API响应内容
`static class`	`Instance.Result`
`class`	`Instance.SetInformationResult`
`static class`	`Instance.StageProgress` StageProgress表示`Task`执行过程中各阶段的进度统计
`static class`	`Instance.Status` Instance的运行状态。
`static class`	`Instance.TaskCost`
`static class`	`Instance.TaskStatus` Task执行状态
`static class`	`Instance.TaskSummary` TaskSummary包含`Task`运行结束后的汇总信息

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addUserDefinedHeaders(Map<String,String> headers)` 设置自定义的 headers, 将被添加到请求的 headers 中
`Date`	`getEndTime()` 获得Instance结束执行时间
`String`	`getId()` 获得Instance的ID
`String`	`getJobName()` 获取 Instance 的 Job name
`String`	`getLog(String workerId, LogType logType, int size)` 获取Worker运行的LOG内容
`Odps`	`getOdps()` 获得Instance的 ODPS 对象
`OdpsHooks`	`getOdpsHooks()`
`String`	`getOwner()` 获得Instance所属用户
`int`	`getPriority()` 获取 Instance 的优先级
`String`	`getProject()` 获得Instance所属`Project`名称
`Instance.InstanceQueueingInfo`	`getQueueingInfo()` 获取运行中 instance 的排队信息
`String`	`getRawSubqueryResults(String subqueryId, String taskName)` 获取SQLRT Instance中Subquery的原始运行结果
`List<Instance.InstanceResultModel.TaskResult>`	`getRawTaskResults()` 获取Instance中Task的原始运行结果
`static String`	`getStageProgressFormattedString(List<Instance.StageProgress> stages)`
`Date`	`getStartTime()` 获得Instance开始执行时间
`Instance.Status`	`getStatus()` 获得Instance状态
`Instance.Status`	`getStatus(boolean isBlock)` 获得Instance状态
`Instance.TaskCost`	`getTaskCost(String taskName)` 获得 Instance 中 Task 的运行资源消耗信息当且仅当 Task 产生计量信息时，返回资源消耗信息，否则返回 null
`String`	`getTaskDetailJson(String taskName)`
`String`	`getTaskDetailJson2(String taskName)`
`String`	`getTaskInfo(String taskName, String infoKey)` 获得 Instance 中 Task 运行时的指定相关信息
`Set<String>`	`getTaskNames()` 获得Instance所包含的所有`Task`的名称
`List<Instance.StageProgress>`	`getTaskProgress(String taskName)` 查询指定Task的Stage进度
`String`	`getTaskQuotaJson(String taskName)` 获取 task 运行 quota group 信息以及 quota group 中作业排队情况注意，此接口的调用频率受限，两次调用间隔不能少于 30s, 否则返回字符串为 {}。
`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`是否执行成功
`boolean`	`isSync()` 获得Instance是否为同步执行
`boolean`	`isTerminated()` 检查是否执行完成
`void`	`reload()` 重新加载属性值
`void`	`setHookInvoked(boolean hookInvoked)`
`Instance.SetInformationResult`	`setInformation(String taskName, String infoKey, String infoValue)` 设置 Instance 中 Task 运行时的指定相关信息,返回结构化response
`void`	`setMcqaV2(boolean mcqaV2)`
`void`	`setOdpsHooks(OdpsHooks hooks)`
`String`	`setTaskInfo(String taskName, String infoKey, String infoValue)` Deprecated.
`String`	`startDebug(String workerId, String debugId)` 以 debug 模式，启动 instance 本接口是提供给内部 debug 工具使用的，不建议用户直接使用
`void`	`stop()` 停止正在执行的Instance 注意：停止动作为异步执行，如果需要确保 Instance 停止，可以在调用本方法后轮询 Instance.isTerminated() 直至返回 true
`void`	`waitForSuccess()` 阻塞当前线程, 直到Instance结束
`void`	`waitForSuccess(long interval)` 阻塞当前线程, 直到Instance结束
`void`	`waitForTerminated(long interval, boolean isBlock)` 阻塞当前线程, 直到Instance结束。不检查 Instance 状态。
`String`	`waitForTerminatedAndGetResult()` 直接获取作业结果，无需调用 waitForSuccess 方法该方法仅适用于一个 Instance 对应一个 Task 的作业

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

- Method Detail
  - reload
```
public void reload()
            throws OdpsException
```
    Description copied from class: LazyLoad
    
    重新加载属性值
    
    Specified by:
    
    reload in class LazyLoad
    
    Throws:
    
    OdpsException
  - stop
```
public void stop()
          throws OdpsException
```
    停止正在执行的Instance 注意：停止动作为异步执行，如果需要确保 Instance 停止，可以在调用本方法后轮询 Instance.isTerminated() 直至返回 true
    
    Throws:
    
    OdpsException
  - getTaskResultsWithFormat
```
public Map<String,Instance.Result> getTaskResultsWithFormat()
                                                     throws OdpsException
```
    获得Instance中Task的运行结果
    
    Returns:
    
    Task的运行结果, key为Task的名称，value为Instance.Result
    
    Throws:
    
    OdpsException
  - getTaskResults
```
public Map<String,String> getTaskResults()
                                  throws OdpsException
```
    获得Instance中Task的运行结果
    
    Returns:
    
    Task的运行结果, key为Task的名称，value为Instance.Result .getString()的结果。
    
    Throws:
    
    OdpsException
  - getRawTaskResults
```
public List<Instance.InstanceResultModel.TaskResult> getRawTaskResults()
                                                                throws OdpsException
```
    获取Instance中Task的原始运行结果
    
    Returns:
    
    Instance.InstanceResultModel.TaskResult列表
    
    Throws:
    
    OdpsException
  - getRawSubqueryResults
```
public String getRawSubqueryResults(String subqueryId,
                                    String taskName)
                             throws OdpsException
```
    获取SQLRT Instance中Subquery的原始运行结果
    
    Returns:
    
    Instance.InstanceResultModel.TaskResult列表
    
    Throws:
    
    OdpsException
  - getTaskCost
```
public Instance.TaskCost getTaskCost(String taskName)
                              throws OdpsException
```
    获得 Instance 中 Task 的运行资源消耗信息当且仅当 Task 产生计量信息时，返回资源消耗信息，否则返回 null
    
    Parameters:
    
    taskName - 指定的TaskName
    
    Returns:
    
    资源消耗信息 Instance.TaskCost
    
    Throws:
    
    OdpsException
  - getTaskInfo
```
public String getTaskInfo(String taskName,
                          String infoKey)
                   throws OdpsException
```
    获得 Instance 中 Task 运行时的指定相关信息
    
    Parameters:
    
    taskName - 指定的TaskName
    
    infoKey - 指定相关信息的标志符
    
    Returns:
    
    相关信息
    
    Throws:
    
    OdpsException
  - setTaskInfo
```
@Deprecated
public String setTaskInfo(String taskName,
                                      String infoKey,
                                      String infoValue)
                               throws OdpsException
```
    Deprecated.
    
    设置 Instance 中 Task 运行时的指定相关信息
    
    Parameters:
    
    taskName - 指定的TaskName
    
    infoKey - 指定相关信息的标志符
    
    infoValue - 指定相关信息的内容
    
    Returns:
    
    相关信息
    
    Throws:
    
    OdpsException
  - setInformation
```
public Instance.SetInformationResult setInformation(String taskName,
                                                    String infoKey,
                                                    String infoValue)
                                             throws OdpsException
```
    设置 Instance 中 Task 运行时的指定相关信息,返回结构化response
    
    Parameters:
    
    taskName - 指定的TaskName
    
    infoKey - 指定相关信息的标志符
    
    infoValue - 指定相关信息的内容
    
    Returns:
    
    SetInformationResult 相关信息及其状态
    
    Throws:
    
    OdpsException
  - getTaskSummary
```
public Instance.TaskSummary getTaskSummary(String taskName)
                                    throws OdpsException
```
    获得Instance中Task的运行汇总信息当 Server 端返回信息，但是信息格式错误时，返回 null
    
    Parameters:
    
    taskName - 指定的TaskName
    
    Returns:
    
    汇总信息 Instance.TaskSummary
    
    Throws:
    
    OdpsException
  - getTaskStatus
```
public Map<String,Instance.TaskStatus> getTaskStatus()
                                              throws OdpsException
```
    查询Instance中所有Task的执行状态
    
    Returns:
    
    Map, key为Task名称, value为表示Task执行状态的Instance.TaskStatus对象
    
    Throws:
    
    OdpsException
  - getTaskNames
```
public Set<String> getTaskNames()
                         throws OdpsException
```
    获得Instance所包含的所有Task的名称
    
    Returns:
    
    Task的名称集合
    
    Throws:
    
    OdpsException
  - isSuccessful
```
public boolean isSuccessful()
                     throws OdpsException
```
    检查Instance是否执行成功
    成功的含义为Instance执行结束,并且所有Task的状态为成功
    
    Returns:
    
    true如果成功
    
    Throws:
    
    OdpsException
  - waitForSuccess
```
public void waitForSuccess()
                    throws OdpsException
```
    阻塞当前线程, 直到Instance结束
    
    Throws:
    
    OdpsException - Instance失败
  - waitForSuccess
```
public void waitForSuccess(long interval)
                    throws OdpsException
```
    阻塞当前线程, 直到Instance结束
    
    Parameters:
    
    interval - 内部轮询间隔
    
    Throws:
    
    OdpsException - Instance失败
  - waitForTerminated
```
public void waitForTerminated(long interval,
                              boolean isBlock)
```
    阻塞当前线程, 直到Instance结束。不检查 Instance 状态。
    
    Parameters:
    
    interval - 内部轮询间隔
    
    isBlock - 是否阻塞, 不开启 block，将在客户端长轮询，直到作业结束开启 block 请求将会在服务端等待一段时间（每次请求等待5s，直到作业结束。long-polling）， block 模式能够跳过 instance post running 阶段（key-path-end optimize）
  - waitForTerminatedAndGetResult
```
public String waitForTerminatedAndGetResult()
                                     throws OdpsException
```
    直接获取作业结果，无需调用 waitForSuccess 方法该方法仅适用于一个 Instance 对应一个 Task 的作业
    
    Throws:
    
    OdpsException
  - getStageProgressFormattedString
```
public static String getStageProgressFormattedString(List<Instance.StageProgress> stages)
```
  - getTaskProgress
```
public List<Instance.StageProgress> getTaskProgress(String taskName)
                                             throws OdpsException
```
    查询指定Task的Stage进度
    
    Parameters:
    
    taskName - Task名称
    
    Returns:
    
    Instance.StageProgress列表
    
    Throws:
    
    OdpsException
  - getOdps
```
public Odps getOdps()
```
    获得Instance的 ODPS 对象
    
    Returns:
    
    Odps 对象
  - getId
```
public String getId()
```
    获得Instance的ID
    
    Returns:
    
    Instance ID
  - getStatus
```
public Instance.Status getStatus(boolean isBlock)
```
    获得Instance状态
    Instance状态如下:
    - RUNNING: 正在执行
    - SUSPENDED: 被挂起
    - TERMINATED: 执行结束, 包括成功、失败、取消等
    Parameters:
    
    isBlock - 是否使用 block 模式若启用 block 模式，请求会被 block 住一定时间（一般是 5s），随后再返回 instance 的状态。若不启用，请求将会立即返回。与接口 getStatus() 的行为一致。
    
    Returns:
    
    返回Status.TERMINATED
  - getStatus
```
public Instance.Status getStatus()
```
    获得Instance状态
    Instance状态如下:
    - RUNNING: 正在执行
    - SUSPENDED: 被挂起
    - TERMINATED: 执行结束, 包括成功、失败、取消等
    Returns:
    
    返回Status.TERMINATED
  - isTerminated
```
public boolean isTerminated()
```
    检查是否执行完成
    
    Returns:
    
    TERMINATED状态返回true, 否则返回false
  - getProject
```
public String getProject()
```
    获得Instance所属Project名称
    
    Returns:
    
    Project名称
  - isSync
```
public boolean isSync()
```
    获得Instance是否为同步执行
    
    Returns:
    
    true如果同步执行
  - getOwner
```
public String getOwner()
```
    获得Instance所属用户
    
    Returns:
    
    用户名
  - getStartTime
```
public Date getStartTime()
```
    获得Instance开始执行时间
    
    Returns:
    
    开始执行时间
  - getEndTime
```
public Date getEndTime()
```
    获得Instance结束执行时间
    
    Returns:
    
    结束执行时间
  - getTasks
```
public List<Task> getTasks()
                    throws OdpsException
```
    返回与作业运行实例相关的作业Task实例。
    
    Returns:
    
    与作业运行实例相关的作业Task实例。
    
    Throws:
    
    OdpsException
  - getPriority
```
public int getPriority()
                throws OdpsException
```
    获取 Instance 的优先级
    
    Returns:
    
    Throws:
    
    OdpsException
  - getJobName
```
public String getJobName()
                  throws OdpsException
```
    获取 Instance 的 Job name
    
    Returns:
    
    job name
    
    Throws:
    
    OdpsException
  - getLog
```
public String getLog(String workerId,
                     LogType logType,
                     int size)
              throws OdpsException
```
    获取Worker运行的LOG内容
    
    Parameters:
    
    workerId - Worker ID，Task 内Worker的唯一标示。
    
    logType - LogType 对象
    
    size - 展示Log内容的长度
    
    Returns:
    
    Log内容
    
    Throws:
    
    OdpsException
    
    IOException
  - getTaskDetailJson
```
public String getTaskDetailJson(String taskName)
                         throws OdpsException
```
    Throws:
    
    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
```
    Throws:
    
    OdpsException
  - getTaskQuotaJson
```
public String getTaskQuotaJson(String taskName)
                        throws OdpsException
```
    获取 task 运行 quota group 信息以及 quota group 中作业排队情况注意，此接口的调用频率受限，两次调用间隔不能少于 30s, 否则返回字符串为 {}。
    
    Parameters:
    
    taskName -
    
    Returns:
    
    task quota 相关信息返回的字符串为 json 格式，下面给出一个例子： {"quotaInfos": { // 格式为 [ odps task 中 fuxi job 名称, fuxi job quota infos] "job0": // fuxi job 名称 "{ "AmWaitingResInfo": // 本 fuxi job 中 fuxi task 的资源使用情况 [taskId, info] [[0, // fuxi task id { "RunningInstanceNum": 1, // fuxi task 中正在运行的 instance 数量 "SlotDesc": {}, // 一个最小资源单元的描述 "SuId": 0, // fuxi task id "TotalInstanceNum": 1, // fuxi task 中运行的 fuxi instance 数量 "totalAheadResourceDesire": {}, // 等待队列中，排在本 fuxi task 之前的 task 所需资源总和，资源包括 CPU 和 memory "totalAheadTaskNum": 0, // 等待队列中，排在本 fuxi task 之前的 task 数量 "waitingQueueItemInfo": {} // 排在本 fuxi task 之前的等待的 job 队列所需资源信息 [jobname, info(cpu,mem)] }]], "GroupAlias": "ttt", // odps task 运行所在 quota 组名称 "GroupId": 1, // odps task 运行所在 quota 组 id "GroupMaxQuota": { // quota 组可用资源上限 "CPU": 67200, "Memory": 2437512}, "GroupRequest": { // 当前 quota 组中 job 申请资源的总和 "CPU": 100, "Memory": 2068}, "RuntimeQuota": { // quota 组当前可被使用的资源总值 "CPU": 100, "Memory": 2068}, "UsedQuota": { // quota 组当前已经被使用的资源总值 "CPU": 100, "Memory": 2068}}" // 空闲 quota = RuntimeQuota - UsedQuota } }
    
    Throws:
    
    OdpsException
  - startDebug
```
public String startDebug(String workerId,
                         String debugId)
                  throws OdpsException
```
    以 debug 模式，启动 instance 本接口是提供给内部 debug 工具使用的，不建议用户直接使用
    
    Parameters:
    
    workerId - Worker ID，Task 内Worker的唯一标示。
    
    debugId - Debug ID, 标志此次 debug
    
    Returns:
    
    启动的结果
    
    Throws:
    
    OdpsException
  - getQueueingInfo
```
public Instance.InstanceQueueingInfo getQueueingInfo()
                                              throws OdpsException
```
    获取运行中 instance 的排队信息
    
    Returns:
    
    Instance.InstanceQueueingInfo的迭代器
    
    Throws:
    
    OdpsException
  - addUserDefinedHeaders
```
public void addUserDefinedHeaders(Map<String,String> headers)
```
    设置自定义的 headers, 将被添加到请求的 headers 中
  - setMcqaV2
```
public void setMcqaV2(boolean mcqaV2)
```

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

reload

stop

getTaskResultsWithFormat

getTaskResults

getRawTaskResults

getRawSubqueryResults

getTaskCost

getTaskInfo

setTaskInfo

setInformation

getTaskSummary

getTaskStatus

getTaskNames

isSuccessful

waitForSuccess

waitForSuccess

waitForTerminated

waitForTerminatedAndGetResult

getStageProgressFormattedString

getTaskProgress

getOdps

getId

getStatus

getStatus

isTerminated

getProject

isSync

getOwner

getStartTime

getEndTime

getTasks

getPriority

getJobName

getLog

getTaskDetailJson

getOdpsHooks

setOdpsHooks

isHookInvoked

setHookInvoked

getTaskDetailJson2

getTaskQuotaJson

startDebug

getQueueingInfo

addUserDefinedHeaders

setMcqaV2