序列化表格 (powerjob-common 4.3.9 API)

程序包 tech.powerjob.common
程序包 tech.powerjob.common.exception
- 类tech.powerjob.common.exception.ImpossibleException扩展RuntimeException实现可序列化
- 类tech.powerjob.common.exception.PowerJobCheckedException扩展Exception实现可序列化
- 类tech.powerjob.common.exception.PowerJobException扩展RuntimeException实现可序列化
程序包 tech.powerjob.common.model
- 类tech.powerjob.common.model.DeployedContainerInfo扩展Object实现可序列化
  - 序列化字段
    - containerId
```
Long containerId
```
      Id of the container.
    - version
```
String version
```
      Version of the container.
    - deployedTime
```
long deployedTime
```
      Deploy timestamp.
    - workerAddress
```
String workerAddress
```
      No need to report to the server
- 类tech.powerjob.common.model.InstanceDetail扩展Object实现可序列化
  - 序列化字段
    - expectedTriggerTime
```
Long expectedTriggerTime
```
      Expected trigger time.
    - actualTriggerTime
```
Long actualTriggerTime
```
      Actual trigger time of an instance.
    - finishedTime
```
Long finishedTime
```
      Finish time of an instance, which may be null.
    - status
```
Integer status
```
      Status of the task instance.
    - result
```
String result
```
      Execution result, which may be null.
    - taskTrackerAddress
```
String taskTrackerAddress
```
      Task tracker address.
    - jobParams
```
String jobParams
```
      任务参数
    - instanceParams
```
String instanceParams
```
      Param string that is passed to an instance when it is initialized.
    - taskDetail
```
InstanceDetail.TaskDetail taskDetail
```
      Task detail, used by MapReduce or Broadcast tasks. 命名有点问题，实际是 task 统计信息
    - queriedTaskDetailInfoList
```
List<E> queriedTaskDetailInfoList
```
      查询出来的 Task 详细结果
    - subInstanceDetails
```
List<E> subInstanceDetails
```
      Sub instance details, used by frequent tasks.
    - runningTimes
```
Long runningTimes
```
      Running times.
    - extra
```
String extra
```
      Extended fields. Middlewares are not supposed to update frequently. Changes in PowerJob-common may lead to incompatible versions. PowerJob-common packages should not be modified if not necessary.
- 类tech.powerjob.common.model.InstanceDetail.SubInstanceDetail扩展Object实现可序列化
  - 序列化字段
    - subInstanceId
```
long subInstanceId
```
    - startTime
```
Long startTime
```
    - finishedTime
```
Long finishedTime
```
    - result
```
String result
```
    - status
```
int status
```
- 类tech.powerjob.common.model.InstanceDetail.TaskDetail扩展Object实现可序列化
  - 序列化字段
    - totalTaskNum
```
long totalTaskNum
```
    - succeedTaskNum
```
long succeedTaskNum
```
    - failedTaskNum
```
long failedTaskNum
```
    - waitingDispatchTaskNum
```
Long waitingDispatchTaskNum
```
    - workerUnreceivedTaskNum
```
Long workerUnreceivedTaskNum
```
    - receivedTaskNum
```
Long receivedTaskNum
```
    - runningTaskNum
```
Long runningTaskNum
```
- 类tech.powerjob.common.model.InstanceLogContent扩展Object实现可序列化
  - 序列化字段
    - instanceId
```
long instanceId
```
      Id of instance.
    - logTime
```
long logTime
```
      Submitted time of the log.
    - logLevel
```
int logLevel
```
      Level of the log.
    - logContent
```
String logContent
```
      Content of the log.
- 类tech.powerjob.common.model.PEWorkflowDAG扩展Object实现可序列化
  - 序列化字段
    - nodes
```
List<E> nodes
```
      Nodes of DAG diagram.
    - edges
```
List<E> edges
```
      Edges of DAG diagram.
- 类tech.powerjob.common.model.PEWorkflowDAG.Edge扩展Object实现可序列化
  - 序列化字段
    - from
```
Long from
```
    - to
```
Long to
```
    - property
```
String property
```
      property,support for complex flow control for decision node , it can be "true" or "false"
    - enable
```
Boolean enable
```
- 类tech.powerjob.common.model.PEWorkflowDAG.Node扩展Object实现可序列化
  - 序列化字段
    - nodeId
```
Long nodeId
```
      node id
      
      从以下版本开始:
      
      20210128
    - nodeType
```
Integer nodeType
```
      note type
      
      从以下版本开始:
      
      20210316
      
      另请参阅:
      
      WorkflowNodeType
    - jobId
```
Long jobId
```
      job id or workflow id (if this Node type is a nested workflow)
      
      另请参阅:
      
      WorkflowNodeType.NESTED_WORKFLOW
    - nodeName
```
String nodeName
```
      node name
    - instanceId
```
Long instanceId
```
    - nodeParams
```
String nodeParams
```
      for decision node, it is JavaScript code
    - status
```
Integer status
```
    - result
```
String result
```
      for decision node, it only be can "true" or "false"
    - enable
```
Boolean enable
```
      instanceId will be null if disable .
    - disableByControlNode
```
Boolean disableByControlNode
```
      mark node which disable by control node.
    - skipWhenFailed
```
Boolean skipWhenFailed
```
    - startTime
```
String startTime
```
    - finishedTime
```
String finishedTime
```
- 类tech.powerjob.common.model.SystemMetrics扩展Object实现可序列化
  - 序列化字段
    - cpuProcessors
```
int cpuProcessors
```
      CPU processor num.
    - cpuLoad
```
double cpuLoad
```
      Percent of CPU load.
    - jvmUsedMemory
```
double jvmUsedMemory
```
      Memory that is used by JVM, in GB.
    - jvmMaxMemory
```
double jvmMaxMemory
```
      Max memory that JVM can use, in GB.
    - jvmMemoryUsage
```
double jvmMemoryUsage
```
      Ratio of memory that JVM uses to total memory, 0.X, the value is between 0 and 1.
    - diskUsed
```
double diskUsed
```
      Total used disk space, in GB.
    - diskTotal
```
double diskTotal
```
      Total disk space, in GB.
    - diskUsage
```
double diskUsage
```
      Used disk ratio.
    - extra
```
String extra
```
      user-customized system metrics collector, eg. GPU usage implement SystemMetricsCollector to set the value in worker side implement WorkerFilter to filter the worker in server side
    - score
```
int score
```
      Score of cache.
- 类tech.powerjob.common.model.TaskDetailInfo扩展Object实现可序列化
  - 序列化字段
    - taskId
```
String taskId
```
    - taskName
```
String taskName
```
    - taskContent
```
String taskContent
```
      任务对象（map 的 subTask）
    - processorAddress
```
String processorAddress
```
      处理器地址
    - status
```
Integer status
```
    - statusStr
```
String statusStr
```
    - result
```
String result
```
    - failedCnt
```
Integer failedCnt
```
    - createdTime
```
Long createdTime
```
      创建时间
    - lastModifiedTime
```
Long lastModifiedTime
```
      最后修改时间
    - lastReportTime
```
Long lastReportTime
```
      ProcessorTracker 最后上报时间
- 类tech.powerjob.common.model.WorkerAppInfo扩展Object实现可序列化
  - 序列化字段
    - appId
```
Long appId
```
      应用唯一 ID
程序包 tech.powerjob.common.request
- 类tech.powerjob.common.request.ServerDeployContainerRequest扩展Object实现可序列化
  - 序列化字段
    - containerId
```
Long containerId
```
      容器ID
    - containerName
```
String containerName
```
      容器名称
    - version
```
String version
```
      文件名（MD5值），用于做版本校验和文件下载
    - downloadURL
```
String downloadURL
```
      下载地址
- 类tech.powerjob.common.request.ServerDestroyContainerRequest扩展Object实现可序列化
  - 序列化字段
    - containerId
```
Long containerId
```
- 类tech.powerjob.common.request.ServerDiscoveryRequest扩展Object实现可序列化
  - 序列化字段
    - appId
```
Long appId
```
    - protocol
```
String protocol
```
    - currentServer
```
String currentServer
```
    - clientVersion
```
String clientVersion
```
- 类tech.powerjob.common.request.ServerQueryInstanceStatusReq扩展Object实现可序列化
  - 序列化字段
    - instanceId
```
Long instanceId
```
    - customQuery
```
String customQuery
```
      自定义查询针对高阶用户，直接开放底库查询，便于运维和排查问题此处只传递查询条件，前置拼接 select *，后置拼接 limit
- 类tech.powerjob.common.request.ServerScheduleJobReq扩展Object实现可序列化
  - 序列化字段
    - allWorkerAddress
```
List<E> allWorkerAddress
```
      可用处理器地址，可能多值，逗号分隔
    - maxWorkerCount
```
Integer maxWorkerCount
```
      最大机器数量
    - jobId
```
Long jobId
```
      任务ID，当更换Server后需要根据 JobId 重新查询任务元数据
    - wfInstanceId
```
Long wfInstanceId
```
    - instanceId
```
Long instanceId
```
      基础信息
    - executeType
```
String executeType
```
      任务执行类型，单机、广播、MR
    - processorType
```
String processorType
```
      处理器类型（内建，外部）
    - processorInfo
```
String processorInfo
```
      处理器信息
    - instanceTimeoutMS
```
long instanceTimeoutMS
```
      整个任务的总体超时时间
    - jobParams
```
String jobParams
```
      任务级别的参数，相当于类的static变量
    - instanceParams
```
String instanceParams
```
      实例级别的参数，相当于类的普通变量（API触发专用，从API触发处带入）
    - threadConcurrency
```
int threadConcurrency
```
      每台机器的处理线程数上限
    - taskRetryNum
```
int taskRetryNum
```
      子任务重试次数（任务本身的重试机制由server控制）
    - timeExpressionType
```
String timeExpressionType
```
      时间表达式类型（CRON/API/FIX_RATE/FIX_DELAY）
    - timeExpression
```
String timeExpression
```
      时间表达式，CRON/NULL/LONG/LONG（单位MS）
    - maxInstanceNum
```
Integer maxInstanceNum
```
      最大同时运行任务数，默认 1
    - alarmConfig
```
String alarmConfig
```
      告警配置
    - logConfig
```
String logConfig
```
      日志配置
    - advancedRuntimeConfig
```
String advancedRuntimeConfig
```
      高级运行时配置
- 类tech.powerjob.common.request.ServerStopInstanceReq扩展Object实现可序列化
  - 序列化字段
    - instanceId
```
Long instanceId
```
- 类tech.powerjob.common.request.TaskTrackerReportInstanceStatusReq扩展Object实现可序列化
  - 序列化字段
    - appId
```
Long appId
```
      追加上报自己的 appId 方便后续的监控日志埋点
    - jobId
```
Long jobId
```
    - instanceId
```
Long instanceId
```
    - wfInstanceId
```
Long wfInstanceId
```
    - appendedWfContext
```
Map<K,V> appendedWfContext
```
      追加的工作流上下文数据
      
      从以下版本开始:
      
      2021/02/05
    - instanceStatus
```
int instanceStatus
```
    - result
```
String result
```
    - totalTaskNum
```
long totalTaskNum
```
    - succeedTaskNum
```
long succeedTaskNum
```
    - failedTaskNum
```
long failedTaskNum
```
    - startTime
```
long startTime
```
    - endTime
```
Long endTime
```
    - reportTime
```
long reportTime
```
    - sourceAddress
```
String sourceAddress
```
    - needAlert
```
boolean needAlert
```
    - alertContent
```
String alertContent
```
- 类tech.powerjob.common.request.WorkerHeartbeat扩展Object实现可序列化
  - 序列化字段
    - workerAddress
```
String workerAddress
```
      本机地址 -> IP:port
    - appName
```
String appName
```
      当前 appName
    - appId
```
Long appId
```
      当前 appId
    - heartbeatTime
```
long heartbeatTime
```
      当前时间
    - containerInfos
```
List<E> containerInfos
```
      当前加载的容器（容器名称 -> 容器版本）
    - version
```
String version
```
      worker 版本信息
    - protocol
```
String protocol
```
      使用的通讯协议 AKKA / HTTP
    - tag
```
String tag
```
      worker tag，标识同一个 worker 下的一类集群 ISSUE: 226
    - client
```
String client
```
      客户端名称
    - extra
```
String extra
```
      扩展字段
    - isOverload
```
boolean isOverload
```
      是否已经超载，超载的情况下 Server 一段时间内不会再向其派发任务
    - lightTaskTrackerNum
```
int lightTaskTrackerNum
```
    - heavyTaskTrackerNum
```
int heavyTaskTrackerNum
```
    - systemMetrics
```
SystemMetrics systemMetrics
```
- 类tech.powerjob.common.request.WorkerLogReportReq扩展Object实现可序列化
  - 序列化字段
    - workerAddress
```
String workerAddress
```
    - instanceLogContents
```
List<E> instanceLogContents
```
- 类tech.powerjob.common.request.WorkerNeedDeployContainerRequest扩展Object实现可序列化
  - 序列化字段
    - containerId
```
Long containerId
```
- 类tech.powerjob.common.request.WorkerQueryExecutorClusterReq扩展Object实现可序列化
  - 序列化字段
    - appId
```
Long appId
```
    - jobId
```
Long jobId
```
程序包 tech.powerjob.common.request.http
- 类tech.powerjob.common.request.http.SaveWorkflowRequest扩展Object实现可序列化
  - 序列化字段
    - id
```
Long id
```
    - wfName
```
String wfName
```
      工作流名称
    - wfDescription
```
String wfDescription
```
      工作流描述
    - appId
```
Long appId
```
      所属应用ID（OpenClient不需要用户填写，自动填充）
    - timeExpressionType
```
TimeExpressionType timeExpressionType
```
      时间表达式类型，仅支持 CRON 和 API
    - timeExpression
```
String timeExpression
```
      时间表达式，CRON/NULL/LONG/LONG
    - maxWfInstanceNum
```
Integer maxWfInstanceNum
```
      最大同时运行的工作流个数，默认 1
    - enable
```
boolean enable
```
      ENABLE / DISABLE
    - notifyUserIds
```
List<E> notifyUserIds
```
      工作流整体失败的报警
    - dag
```
PEWorkflowDAG dag
```
      点线表示法
    - lifeCycle
```
LifeCycle lifeCycle
```
程序包 tech.powerjob.common.response
- 类tech.powerjob.common.response.AskResponse扩展Object实现可序列化
  - 序列化字段
    - success
```
boolean success
```
    - data
```
byte[] data
```
    - message
```
String message
```
- 类tech.powerjob.common.response.ObjectResultDTO扩展ResultDTO<Object>实现可序列化
- 类tech.powerjob.common.response.ResultDTO扩展Object实现可序列化
  - 序列化字段
    - success
```
boolean success
```
    - data
```
Object data
```
    - message
```
String message
```

序列化表格

程序包 tech.powerjob.common

程序包 tech.powerjob.common.exception

类tech.powerjob.common.exception.ImpossibleException扩展RuntimeException实现可序列化

类tech.powerjob.common.exception.PowerJobCheckedException扩展Exception实现可序列化

类tech.powerjob.common.exception.PowerJobException扩展RuntimeException实现可序列化

程序包 tech.powerjob.common.model

类tech.powerjob.common.model.DeployedContainerInfo扩展Object实现可序列化

序列化字段

containerId

version

deployedTime

workerAddress

类tech.powerjob.common.model.InstanceDetail扩展Object实现可序列化

序列化字段

expectedTriggerTime

actualTriggerTime

finishedTime

status

result

taskTrackerAddress

jobParams

instanceParams

taskDetail

queriedTaskDetailInfoList

subInstanceDetails

runningTimes

extra

类tech.powerjob.common.model.InstanceDetail.SubInstanceDetail扩展Object实现可序列化

序列化字段

subInstanceId

startTime

finishedTime

result

status

类tech.powerjob.common.model.InstanceDetail.TaskDetail扩展Object实现可序列化

序列化字段

totalTaskNum

succeedTaskNum

failedTaskNum

waitingDispatchTaskNum

workerUnreceivedTaskNum

receivedTaskNum

runningTaskNum

类tech.powerjob.common.model.InstanceLogContent扩展Object实现可序列化

序列化字段

instanceId

logTime

logLevel

logContent

类tech.powerjob.common.model.PEWorkflowDAG扩展Object实现可序列化

序列化字段

nodes

edges

类tech.powerjob.common.model.PEWorkflowDAG.Edge扩展Object实现可序列化

序列化字段

from

to

property

enable

类tech.powerjob.common.model.PEWorkflowDAG.Node扩展Object实现可序列化

序列化字段

nodeId

nodeType

jobId

nodeName

instanceId

nodeParams

status

result

enable

disableByControlNode

skipWhenFailed

startTime

finishedTime

类tech.powerjob.common.model.SystemMetrics扩展Object实现可序列化

序列化字段

cpuProcessors

cpuLoad

jvmUsedMemory