PowerJobClient (powerjob-client 4.3.9 API)

java.lang.Object
- tech.powerjob.client.PowerJobClient

所有已实现的接口:

IPowerJobClient
```
public class PowerJobClient
extends Object
implements IPowerJobClient
```
PowerJobClient, the client for OpenAPI.

从以下版本开始:

2020/4/15

作者:

tjq

构造器概要

构造器
构造器和说明
`PowerJobClient(List<String> addressList, String appName, String password)` Init PowerJobClient with server address, appName and password.
`PowerJobClient(String domain, String appName, String password)` Init PowerJobClient with domain, appName and password.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ResultDTO<Void>`	`cancelInstance(Long instanceId)` Cancel a job instance that is not yet running Notice：There is a time interval between the call interface time and the expected execution time of the job instance to be cancelled, otherwise reliability is not guaranteed
`ResultDTO<Long>`	`copyJob(Long jobId)` Copy one Job
`ResultDTO<Long>`	`copyWorkflow(Long workflowId)` Copy one workflow
`ResultDTO<Void>`	`deleteJob(Long jobId)` Delete one job by jobId
`ResultDTO<Void>`	`deleteWorkflow(Long workflowId)` Delete Workflow by workflowId
`ResultDTO<Void>`	`disableJob(Long jobId)` Disable one Job by jobId
`ResultDTO<Void>`	`disableWorkflow(Long workflowId)` Disable Workflow by workflowId
`ResultDTO<Void>`	`enableJob(Long jobId)` Enable one job by jobId
`ResultDTO<Void>`	`enableWorkflow(Long workflowId)` Enable Workflow by workflowId
`ResultDTO<SaveJobInfoRequest>`	`exportJob(Long jobId)`
`ResultDTO<List<JobInfoDTO>>`	`fetchAllJob()` Query all JobInfo
`ResultDTO<InstanceInfoDTO>`	`fetchInstanceInfo(Long instanceId)` Query detail about a job instance
`ResultDTO<Integer>`	`fetchInstanceStatus(Long instanceId)` Query status about a job instance
`ResultDTO<JobInfoDTO>`	`fetchJob(Long jobId)` Query JobInfo by jobId
`ResultDTO<WorkflowInfoDTO>`	`fetchWorkflow(Long workflowId)` Query Workflow by workflowId
`ResultDTO<WorkflowInstanceInfoDTO>`	`fetchWorkflowInstanceInfo(Long wfInstanceId)` Query detail about a workflow instance
`ResultDTO<Void>`	`markWorkflowNodeAsSuccess(Long wfInstanceId, Long nodeId)` mark the workflow node as success
`ResultDTO<List<JobInfoDTO>>`	`queryJob(JobInfoQuery powerQuery)` Query JobInfo by PowerQuery
`ResultDTO<Void>`	`retryInstance(Long instanceId)` Retry failed job instance Notice: Only job instance with completion status (success, failure, manually stopped, cancelled) can be retried, and retries of job instances within workflows are not supported yet.
`ResultDTO<Void>`	`retryWorkflowInstance(Long wfInstanceId)` Retry one workflow instance
`ResultDTO<Long>`	`runJob(Long jobId)`
`ResultDTO<Long>`	`runJob(Long jobId, String instanceParams, long delayMS)` Run a job once
`ResultDTO<Long>`	`runWorkflow(Long workflowId)`
`ResultDTO<Long>`	`runWorkflow(Long workflowId, String initParams, long delayMS)` Run a workflow once
`ResultDTO<Long>`	`saveJob(SaveJobInfoRequest request)` Save one Job When an ID exists in SaveJobInfoRequest, it is an update operation.
`ResultDTO<Long>`	`saveWorkflow(SaveWorkflowRequest request)` Save one workflow When an ID exists in SaveWorkflowRequest, it is an update operation.
`ResultDTO<List<WorkflowNodeInfoDTO>>`	`saveWorkflowNode(List<SaveWorkflowNodeRequest> requestList)` 添加工作流节点
`ResultDTO<Void>`	`stopInstance(Long instanceId)` Stop one job instance
`ResultDTO<Void>`	`stopWorkflowInstance(Long wfInstanceId)` Stop one workflow instance

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

- 构造器详细资料
  - PowerJobClient
```
public PowerJobClient(String domain,
                      String appName,
                      String password)
```
    Init PowerJobClient with domain, appName and password.
    
    参数:
    
    domain - like powerjob-server.apple-inc.com (Intranet Domain)
    
    appName - name of the application
    
    password - password of the application
  - PowerJobClient
```
public PowerJobClient(List<String> addressList,
                      String appName,
                      String password)
```
    Init PowerJobClient with server address, appName and password.
    
    参数:
    
    addressList - IP:Port address list, like 192.168.1.1:7700
    
    appName - name of the application
    
    password - password of the application
- 方法详细资料
  - saveJob
```
public ResultDTO<Long> saveJob(SaveJobInfoRequest request)
```
    Save one Job When an ID exists in SaveJobInfoRequest, it is an update operation. Otherwise, it is a crate operation.
    
    指定者:
    
    saveJob 在接口中 IPowerJobClient
    
    参数:
    
    request - Job meta info
    
    返回:
    
    jobId
  - copyJob
```
public ResultDTO<Long> copyJob(Long jobId)
```
    Copy one Job
    
    指定者:
    
    copyJob 在接口中 IPowerJobClient
    
    参数:
    
    jobId - Job id
    
    返回:
    
    Id of job copy
  - exportJob
```
public ResultDTO<SaveJobInfoRequest> exportJob(Long jobId)
```
    指定者:
    
    exportJob 在接口中 IPowerJobClient
  - fetchJob
```
public ResultDTO<JobInfoDTO> fetchJob(Long jobId)
```
    Query JobInfo by jobId
    
    指定者:
    
    fetchJob 在接口中 IPowerJobClient
    
    参数:
    
    jobId - jobId
    
    返回:
    
    Job meta info
  - fetchAllJob
```
public ResultDTO<List<JobInfoDTO>> fetchAllJob()
```
    Query all JobInfo
    
    指定者:
    
    fetchAllJob 在接口中 IPowerJobClient
    
    返回:
    
    All JobInfo
  - queryJob
```
public ResultDTO<List<JobInfoDTO>> queryJob(JobInfoQuery powerQuery)
```
    Query JobInfo by PowerQuery
    
    指定者:
    
    queryJob 在接口中 IPowerJobClient
    
    参数:
    
    powerQuery - JobQuery
    
    返回:
    
    JobInfo
  - disableJob
```
public ResultDTO<Void> disableJob(Long jobId)
```
    Disable one Job by jobId
    
    指定者:
    
    disableJob 在接口中 IPowerJobClient
    
    参数:
    
    jobId - jobId
    
    返回:
    
    Standard return object
  - enableJob
```
public ResultDTO<Void> enableJob(Long jobId)
```
    Enable one job by jobId
    
    指定者:
    
    enableJob 在接口中 IPowerJobClient
    
    参数:
    
    jobId - jobId
    
    返回:
    
    Standard return object
  - deleteJob
```
public ResultDTO<Void> deleteJob(Long jobId)
```
    Delete one job by jobId
    
    指定者:
    
    deleteJob 在接口中 IPowerJobClient
    
    参数:
    
    jobId - jobId
    
    返回:
    
    Standard return object
  - runJob
```
public ResultDTO<Long> runJob(Long jobId,
                              String instanceParams,
                              long delayMS)
```
    Run a job once
    
    指定者:
    
    runJob 在接口中 IPowerJobClient
    
    参数:
    
    jobId - ID of the job to be run
    
    instanceParams - Runtime parameters of the job (TaskContext#instanceParams)
    
    delayMS - Delay time（Milliseconds）
    
    返回:
    
    instanceId
  - runJob
```
public ResultDTO<Long> runJob(Long jobId)
```
  - stopInstance
```
public ResultDTO<Void> stopInstance(Long instanceId)
```
    Stop one job instance
    
    指定者:
    
    stopInstance 在接口中 IPowerJobClient
    
    参数:
    
    instanceId - instanceId
    
    返回:
    
    Standard return object
  - cancelInstance
```
public ResultDTO<Void> cancelInstance(Long instanceId)
```
    Cancel a job instance that is not yet running Notice：There is a time interval between the call interface time and the expected execution time of the job instance to be cancelled, otherwise reliability is not guaranteed
    
    指定者:
    
    cancelInstance 在接口中 IPowerJobClient
    
    参数:
    
    instanceId - instanceId
    
    返回:
    
    Standard return object
  - retryInstance
```
public ResultDTO<Void> retryInstance(Long instanceId)
```
    Retry failed job instance Notice: Only job instance with completion status (success, failure, manually stopped, cancelled) can be retried, and retries of job instances within workflows are not supported yet.
    
    指定者:
    
    retryInstance 在接口中 IPowerJobClient
    
    参数:
    
    instanceId - instanceId
    
    返回:
    
    Standard return object
  - fetchInstanceStatus
```
public ResultDTO<Integer> fetchInstanceStatus(Long instanceId)
```
    Query status about a job instance
    
    指定者:
    
    fetchInstanceStatus 在接口中 IPowerJobClient
    
    参数:
    
    instanceId - instanceId
    
    返回:
    
    InstanceStatus
  - fetchInstanceInfo
```
public ResultDTO<InstanceInfoDTO> fetchInstanceInfo(Long instanceId)
```
    Query detail about a job instance
    
    指定者:
    
    fetchInstanceInfo 在接口中 IPowerJobClient
    
    参数:
    
    instanceId - instanceId
    
    返回:
    
    instance detail
  - saveWorkflow
```
public ResultDTO<Long> saveWorkflow(SaveWorkflowRequest request)
```
    Save one workflow When an ID exists in SaveWorkflowRequest, it is an update operation. Otherwise, it is a crate operation.
    
    指定者:
    
    saveWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    request - Workflow meta info
    
    返回:
    
    workflowId
  - copyWorkflow
```
public ResultDTO<Long> copyWorkflow(Long workflowId)
```
    Copy one workflow
    
    指定者:
    
    copyWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    workflowId - Workflow id
    
    返回:
    
    Id of workflow copy
  - saveWorkflowNode
```
public ResultDTO<List<WorkflowNodeInfoDTO>> saveWorkflowNode(List<SaveWorkflowNodeRequest> requestList)
```
    添加工作流节点
    
    指定者:
    
    saveWorkflowNode 在接口中 IPowerJobClient
    
    参数:
    
    requestList - Node info list of Workflow
    
    返回:
    
    Standard return object
  - fetchWorkflow
```
public ResultDTO<WorkflowInfoDTO> fetchWorkflow(Long workflowId)
```
    Query Workflow by workflowId
    
    指定者:
    
    fetchWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    workflowId - workflowId
    
    返回:
    
    Workflow meta info
  - disableWorkflow
```
public ResultDTO<Void> disableWorkflow(Long workflowId)
```
    Disable Workflow by workflowId
    
    指定者:
    
    disableWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    workflowId - workflowId
    
    返回:
    
    Standard return object
  - enableWorkflow
```
public ResultDTO<Void> enableWorkflow(Long workflowId)
```
    Enable Workflow by workflowId
    
    指定者:
    
    enableWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    workflowId - workflowId
    
    返回:
    
    Standard return object
  - deleteWorkflow
```
public ResultDTO<Void> deleteWorkflow(Long workflowId)
```
    Delete Workflow by workflowId
    
    指定者:
    
    deleteWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    workflowId - workflowId
    
    返回:
    
    Standard return object
  - runWorkflow
```
public ResultDTO<Long> runWorkflow(Long workflowId,
                                   String initParams,
                                   long delayMS)
```
    Run a workflow once
    
    指定者:
    
    runWorkflow 在接口中 IPowerJobClient
    
    参数:
    
    workflowId - workflowId
    
    initParams - workflow startup parameters
    
    delayMS - Delay time（Milliseconds）
    
    返回:
    
    workflow instanceId
  - runWorkflow
```
public ResultDTO<Long> runWorkflow(Long workflowId)
```
  - stopWorkflowInstance
```
public ResultDTO<Void> stopWorkflowInstance(Long wfInstanceId)
```
    Stop one workflow instance
    
    指定者:
    
    stopWorkflowInstance 在接口中 IPowerJobClient
    
    参数:
    
    wfInstanceId - workflow instanceId
    
    返回:
    
    Standard return object
  - retryWorkflowInstance
```
public ResultDTO<Void> retryWorkflowInstance(Long wfInstanceId)
```
    Retry one workflow instance
    
    指定者:
    
    retryWorkflowInstance 在接口中 IPowerJobClient
    
    参数:
    
    wfInstanceId - workflow instanceId
    
    返回:
    
    Standard return object
  - markWorkflowNodeAsSuccess
```
public ResultDTO<Void> markWorkflowNodeAsSuccess(Long wfInstanceId,
                                                 Long nodeId)
```
    mark the workflow node as success
    
    指定者:
    
    markWorkflowNodeAsSuccess 在接口中 IPowerJobClient
    
    参数:
    
    wfInstanceId - workflow instanceId
    
    nodeId - node id
    
    返回:
    
    Standard return object
  - fetchWorkflowInstanceInfo
```
public ResultDTO<WorkflowInstanceInfoDTO> fetchWorkflowInstanceInfo(Long wfInstanceId)
```
    Query detail about a workflow instance
    
    指定者:
    
    fetchWorkflowInstanceInfo 在接口中 IPowerJobClient
    
    参数:
    
    wfInstanceId - workflow instanceId
    
    返回:
    
    detail about a workflow

类 PowerJobClient

构造器概要

方法概要

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

构造器详细资料

PowerJobClient

PowerJobClient

方法详细资料

saveJob

copyJob

exportJob

fetchJob

fetchAllJob

queryJob

disableJob

enableJob

deleteJob

runJob

runJob

stopInstance

cancelInstance

retryInstance

fetchInstanceStatus

fetchInstanceInfo

saveWorkflow

copyWorkflow

saveWorkflowNode

fetchWorkflow

disableWorkflow

enableWorkflow

deleteWorkflow

runWorkflow

runWorkflow

stopWorkflowInstance

retryWorkflowInstance

markWorkflowNodeAsSuccess

fetchWorkflowInstanceInfo