BatchClient (tencentcloud-sdk-java 3.0.3 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.batch.v20170312.BatchClient

public class BatchClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`BatchClient(Credential credential, String region)` 构造client
`BatchClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

Methods
Modifier and Type	Method and Description
`CreateComputeEnvResponse`	`CreateComputeEnv(CreateComputeEnvRequest req)` 用于创建计算环境
`CreateTaskTemplateResponse`	`CreateTaskTemplate(CreateTaskTemplateRequest req)` 用于创建任务模板
`DeleteComputeEnvResponse`	`DeleteComputeEnv(DeleteComputeEnvRequest req)` 用于删除计算环境
`DeleteJobResponse`	`DeleteJob(DeleteJobRequest req)` 用于删除作业记录。删除作业的效果相当于删除作业相关的所有信息。删除成功后，作业相关的所有信息都无法查询。待删除的作业必须处于完结状态，且其内部包含的所有任务实例也必须处于完结状态，否则会禁止操作。完结状态，是指处于 SUCCEED 或 FAILED 状态。
`DeleteTaskTemplatesResponse`	`DeleteTaskTemplates(DeleteTaskTemplatesRequest req)` 用于删除任务模板信息
`DescribeAvailableCvmInstanceTypesResponse`	`DescribeAvailableCvmInstanceTypes(DescribeAvailableCvmInstanceTypesRequest req)` 查看可用的CVM机型配置信息
`DescribeComputeEnvResponse`	`DescribeComputeEnv(DescribeComputeEnvRequest req)` 用于查询计算环境的详细信息
`DescribeComputeEnvActivitiesResponse`	`DescribeComputeEnvActivities(DescribeComputeEnvActivitiesRequest req)` 用于查询计算环境的活动信息
`DescribeComputeEnvCreateInfoResponse`	`DescribeComputeEnvCreateInfo(DescribeComputeEnvCreateInfoRequest req)` 查看计算环境的创建信息。
`DescribeComputeEnvCreateInfosResponse`	`DescribeComputeEnvCreateInfos(DescribeComputeEnvCreateInfosRequest req)` 用于查看计算环境创建信息列表，包括名称、描述、类型、环境参数、通知及期望节点数等。
`DescribeComputeEnvsResponse`	`DescribeComputeEnvs(DescribeComputeEnvsRequest req)` 用于查看计算环境列表
`DescribeJobResponse`	`DescribeJob(DescribeJobRequest req)` 用于查看一个作业的详细信息，包括内部任务（Task）和依赖（Dependence）信息。
`DescribeJobsResponse`	`DescribeJobs(DescribeJobsRequest req)` 用于查询若干个作业的概览信息
`DescribeJobSubmitInfoResponse`	`DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)` 用于查询指定作业的提交信息，其返回内容包括 JobId 和 SubmitJob 接口中作为输入参数的作业提交信息
`DescribeTaskResponse`	`DescribeTask(DescribeTaskRequest req)` 用于查询指定任务的详细信息，包括任务内部的任务实例信息。
`DescribeTaskTemplatesResponse`	`DescribeTaskTemplates(DescribeTaskTemplatesRequest req)` 用于查询任务模板信息
`ModifyComputeEnvResponse`	`ModifyComputeEnv(ModifyComputeEnvRequest req)` 用于修改计算环境的期望节点数量
`ModifyTaskTemplateResponse`	`ModifyTaskTemplate(ModifyTaskTemplateRequest req)` 用于修改任务模板
`SubmitJobResponse`	`SubmitJob(SubmitJobRequest req)` 用于提交一个作业
`TerminateComputeNodeResponse`	`TerminateComputeNode(TerminateComputeNodeRequest req)` 用于销毁计算节点。对于状态为CREATED、CREATION_FAILED、RUNNING和ABNORMAL的节点，允许销毁处理。
`TerminateJobResponse`	`TerminateJob(TerminateJobRequest req)` 用于终止作业。终止作业的效果相当于所含的所有任务实例进行TerminateTaskInstance操作。具体效果和用法可参考TerminateTaskInstance。
`TerminateTaskInstanceResponse`	`TerminateTaskInstance(TerminateTaskInstanceRequest req)` 用于终止任务实例对于状态已经为SUCCEED、FAILED的TaskInstance，batch不做处理。对于状态为SUBMITTED、PENDING、RUNNABLE的TaskInstance，batch会将其置为FAILED状态。对于状态为STARTING、RUNNING、FAILED_INTERRUPTED的TaskInstance，batch会先终止CVM，然后将状态置为FAILED，因此具有一定耗时。特别是如果CVM正在创建中，此时无法立即销毁CVM，Batch会在旁路注册一个定时销毁操作，在CVM创建好之后异步销毁。对于状态为FAILED_INTERRUPTED的TaskInstance，TerminateTaskInstance操作实际成功之后，相关资源和配额才会释放。本接口只支持提交到匿名计算环境的作业（SubmitJob指定ComputeEnv，不指定EnvId）。对于提交到具名计算环境的作业（SubmitJob指定EnvId，不指定ComputeEnv），不支持TerminateTaskInstance和TerminateJob操作。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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

- Constructor Detail
  - BatchClient
```
public BatchClient(Credential credential,
           String region)
```
    构造client
    
    Parameters:
    credential - 认证信息实例
    region - 产品地域
  - BatchClient
```
public BatchClient(Credential credential,
           String region,
           ClientProfile profile)
```
    构造client
    
    Parameters:
    credential - 认证信息实例
    region - 产品地域
    profile - 配置实例
- Method Detail
  - CreateComputeEnv
```
public CreateComputeEnvResponse CreateComputeEnv(CreateComputeEnvRequest req)
                                          throws TencentCloudSDKException
```
    用于创建计算环境
    
    Parameters:
    CreateComputeEnvRequest -
    
    Returns:
    CreateComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTaskTemplate
```
public CreateTaskTemplateResponse CreateTaskTemplate(CreateTaskTemplateRequest req)
                                              throws TencentCloudSDKException
```
    用于创建任务模板
    
    Parameters:
    CreateTaskTemplateRequest -
    
    Returns:
    CreateTaskTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteComputeEnv
```
public DeleteComputeEnvResponse DeleteComputeEnv(DeleteComputeEnvRequest req)
                                          throws TencentCloudSDKException
```
    用于删除计算环境
    
    Parameters:
    DeleteComputeEnvRequest -
    
    Returns:
    DeleteComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteJob
```
public DeleteJobResponse DeleteJob(DeleteJobRequest req)
                            throws TencentCloudSDKException
```
    用于删除作业记录。删除作业的效果相当于删除作业相关的所有信息。删除成功后，作业相关的所有信息都无法查询。待删除的作业必须处于完结状态，且其内部包含的所有任务实例也必须处于完结状态，否则会禁止操作。完结状态，是指处于 SUCCEED 或 FAILED 状态。
    
    Parameters:
    DeleteJobRequest -
    
    Returns:
    DeleteJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTaskTemplates
```
public DeleteTaskTemplatesResponse DeleteTaskTemplates(DeleteTaskTemplatesRequest req)
                                                throws TencentCloudSDKException
```
    用于删除任务模板信息
    
    Parameters:
    DeleteTaskTemplatesRequest -
    
    Returns:
    DeleteTaskTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAvailableCvmInstanceTypes
```
public DescribeAvailableCvmInstanceTypesResponse DescribeAvailableCvmInstanceTypes(DescribeAvailableCvmInstanceTypesRequest req)
                                                                            throws TencentCloudSDKException
```
    查看可用的CVM机型配置信息
    
    Parameters:
    DescribeAvailableCvmInstanceTypesRequest -
    
    Returns:
    DescribeAvailableCvmInstanceTypesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnv
```
public DescribeComputeEnvResponse DescribeComputeEnv(DescribeComputeEnvRequest req)
                                              throws TencentCloudSDKException
```
    用于查询计算环境的详细信息
    
    Parameters:
    DescribeComputeEnvRequest -
    
    Returns:
    DescribeComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvActivities
```
public DescribeComputeEnvActivitiesResponse DescribeComputeEnvActivities(DescribeComputeEnvActivitiesRequest req)
                                                                  throws TencentCloudSDKException
```
    用于查询计算环境的活动信息
    
    Parameters:
    DescribeComputeEnvActivitiesRequest -
    
    Returns:
    DescribeComputeEnvActivitiesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvCreateInfo
```
public DescribeComputeEnvCreateInfoResponse DescribeComputeEnvCreateInfo(DescribeComputeEnvCreateInfoRequest req)
                                                                  throws TencentCloudSDKException
```
    查看计算环境的创建信息。
    
    Parameters:
    DescribeComputeEnvCreateInfoRequest -
    
    Returns:
    DescribeComputeEnvCreateInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvCreateInfos
```
public DescribeComputeEnvCreateInfosResponse DescribeComputeEnvCreateInfos(DescribeComputeEnvCreateInfosRequest req)
                                                                    throws TencentCloudSDKException
```
    用于查看计算环境创建信息列表，包括名称、描述、类型、环境参数、通知及期望节点数等。
    
    Parameters:
    DescribeComputeEnvCreateInfosRequest -
    
    Returns:
    DescribeComputeEnvCreateInfosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvs
```
public DescribeComputeEnvsResponse DescribeComputeEnvs(DescribeComputeEnvsRequest req)
                                                throws TencentCloudSDKException
```
    用于查看计算环境列表
    
    Parameters:
    DescribeComputeEnvsRequest -
    
    Returns:
    DescribeComputeEnvsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJob
```
public DescribeJobResponse DescribeJob(DescribeJobRequest req)
                                throws TencentCloudSDKException
```
    用于查看一个作业的详细信息，包括内部任务（Task）和依赖（Dependence）信息。
    
    Parameters:
    DescribeJobRequest -
    
    Returns:
    DescribeJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobSubmitInfo
```
public DescribeJobSubmitInfoResponse DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)
                                                    throws TencentCloudSDKException
```
    用于查询指定作业的提交信息，其返回内容包括 JobId 和 SubmitJob 接口中作为输入参数的作业提交信息
    
    Parameters:
    DescribeJobSubmitInfoRequest -
    
    Returns:
    DescribeJobSubmitInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobs
```
public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req)
                                  throws TencentCloudSDKException
```
    用于查询若干个作业的概览信息
    
    Parameters:
    DescribeJobsRequest -
    
    Returns:
    DescribeJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTask
```
public DescribeTaskResponse DescribeTask(DescribeTaskRequest req)
                                  throws TencentCloudSDKException
```
    用于查询指定任务的详细信息，包括任务内部的任务实例信息。
    
    Parameters:
    DescribeTaskRequest -
    
    Returns:
    DescribeTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTaskTemplates
```
public DescribeTaskTemplatesResponse DescribeTaskTemplates(DescribeTaskTemplatesRequest req)
                                                    throws TencentCloudSDKException
```
    用于查询任务模板信息
    
    Parameters:
    DescribeTaskTemplatesRequest -
    
    Returns:
    DescribeTaskTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyComputeEnv
```
public ModifyComputeEnvResponse ModifyComputeEnv(ModifyComputeEnvRequest req)
                                          throws TencentCloudSDKException
```
    用于修改计算环境的期望节点数量
    
    Parameters:
    ModifyComputeEnvRequest -
    
    Returns:
    ModifyComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTaskTemplate
```
public ModifyTaskTemplateResponse ModifyTaskTemplate(ModifyTaskTemplateRequest req)
                                              throws TencentCloudSDKException
```
    用于修改任务模板
    
    Parameters:
    ModifyTaskTemplateRequest -
    
    Returns:
    ModifyTaskTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - SubmitJob
```
public SubmitJobResponse SubmitJob(SubmitJobRequest req)
                            throws TencentCloudSDKException
```
    用于提交一个作业
    
    Parameters:
    SubmitJobRequest -
    
    Returns:
    SubmitJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateComputeNode
```
public TerminateComputeNodeResponse TerminateComputeNode(TerminateComputeNodeRequest req)
                                                  throws TencentCloudSDKException
```
    用于销毁计算节点。对于状态为CREATED、CREATION_FAILED、RUNNING和ABNORMAL的节点，允许销毁处理。
    
    Parameters:
    TerminateComputeNodeRequest -
    
    Returns:
    TerminateComputeNodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateJob
```
public TerminateJobResponse TerminateJob(TerminateJobRequest req)
                                  throws TencentCloudSDKException
```
    用于终止作业。终止作业的效果相当于所含的所有任务实例进行TerminateTaskInstance操作。具体效果和用法可参考TerminateTaskInstance。
    
    Parameters:
    TerminateJobRequest -
    
    Returns:
    TerminateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateTaskInstance
```
public TerminateTaskInstanceResponse TerminateTaskInstance(TerminateTaskInstanceRequest req)
                                                    throws TencentCloudSDKException
```
    用于终止任务实例对于状态已经为SUCCEED、FAILED的TaskInstance，batch不做处理。对于状态为SUBMITTED、PENDING、RUNNABLE的TaskInstance，batch会将其置为FAILED状态。对于状态为STARTING、RUNNING、FAILED_INTERRUPTED的TaskInstance，batch会先终止CVM，然后将状态置为FAILED，因此具有一定耗时。特别是如果CVM正在创建中，此时无法立即销毁CVM，Batch会在旁路注册一个定时销毁操作，在CVM创建好之后异步销毁。对于状态为FAILED_INTERRUPTED的TaskInstance，TerminateTaskInstance操作实际成功之后，相关资源和配额才会释放。本接口只支持提交到匿名计算环境的作业（SubmitJob指定ComputeEnv，不指定EnvId）。对于提交到具名计算环境的作业（SubmitJob指定EnvId，不指定ComputeEnv），不支持TerminateTaskInstance和TerminateJob操作。
    
    Parameters:
    TerminateTaskInstanceRequest -
    
    Returns:
    TerminateTaskInstanceResponse
    
    Throws:
    
    TencentCloudSDKException

Class BatchClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

BatchClient

BatchClient

Method Detail

CreateComputeEnv

CreateTaskTemplate

DeleteComputeEnv

DeleteJob

DeleteTaskTemplates

DescribeAvailableCvmInstanceTypes

DescribeComputeEnv

DescribeComputeEnvActivities

DescribeComputeEnvCreateInfo

DescribeComputeEnvCreateInfos

DescribeComputeEnvs

DescribeJob

DescribeJobSubmitInfo

DescribeJobs

DescribeTask

DescribeTaskTemplates

ModifyComputeEnv

ModifyTaskTemplate

SubmitJob

TerminateComputeNode

TerminateJob

TerminateTaskInstance