OceanusClient (tencentcloud-sdk-java 3.1.1139 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.oceanus.v20190422.OceanusClient

public class OceanusClient
extends AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`OceanusClient(Credential credential, String region)`
`OceanusClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CheckSavepointResponse`	`CheckSavepoint(CheckSavepointRequest req)` 检查快照是否可用
`CopyJobsResponse`	`CopyJobs(CopyJobsRequest req)` 单条和批量复制作业
`CreateFolderResponse`	`CreateFolder(CreateFolderRequest req)` 作业列表页面新建文件夹请求
`CreateJobResponse`	`CreateJob(CreateJobRequest req)` 新建作业接口，一个 AppId 最多允许创建1000个作业
`CreateJobConfigResponse`	`CreateJobConfig(CreateJobConfigRequest req)` 创建作业配置，一个作业最多有100个配置版本
`CreateResourceResponse`	`CreateResource(CreateResourceRequest req)` 创建资源接口
`CreateResourceConfigResponse`	`CreateResourceConfig(CreateResourceConfigRequest req)` 创建资源配置接口
`CreateWorkSpaceResponse`	`CreateWorkSpace(CreateWorkSpaceRequest req)` 创建工作空间
`DeleteFoldersResponse`	`DeleteFolders(DeleteFoldersRequest req)` 作业列表删除文件夹
`DeleteJobConfigsResponse`	`DeleteJobConfigs(DeleteJobConfigsRequest req)` 删除作业配置
`DeleteJobsResponse`	`DeleteJobs(DeleteJobsRequest req)` 批量删除作业接口，批量操作数量上限20
`DeleteResourceConfigsResponse`	`DeleteResourceConfigs(DeleteResourceConfigsRequest req)` 删除资源版本
`DeleteResourcesResponse`	`DeleteResources(DeleteResourcesRequest req)` 删除资源接口
`DeleteTableConfigResponse`	`DeleteTableConfig(DeleteTableConfigRequest req)` 删除作业表配置
`DeleteWorkSpaceResponse`	`DeleteWorkSpace(DeleteWorkSpaceRequest req)` 删除工作空间
`DescribeClustersResponse`	`DescribeClusters(DescribeClustersRequest req)` 查询集群
`DescribeFolderResponse`	`DescribeFolder(DescribeFolderRequest req)` 查询指定文件夹及其相应的子文件夹信息
`DescribeJobConfigsResponse`	`DescribeJobConfigs(DescribeJobConfigsRequest req)` 查询作业配置列表，一次最多查询100个
`DescribeJobEventsResponse`	`DescribeJobEvents(DescribeJobEventsRequest req)` 获取指定作业的事件，包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型
`DescribeJobRuntimeInfoResponse`	`DescribeJobRuntimeInfo(DescribeJobRuntimeInfoRequest req)` 获取作业运行时的信息
`DescribeJobsResponse`	`DescribeJobs(DescribeJobsRequest req)` 查询作业
`DescribeJobSavepointResponse`	`DescribeJobSavepoint(DescribeJobSavepointRequest req)` 查找Savepoint列表
`DescribeJobSubmissionLogResponse`	`DescribeJobSubmissionLog(DescribeJobSubmissionLogRequest req)` 查询作业实例启动日志
`DescribeResourceConfigsResponse`	`DescribeResourceConfigs(DescribeResourceConfigsRequest req)` 描述资源配置接口
`DescribeResourceRelatedJobsResponse`	`DescribeResourceRelatedJobs(DescribeResourceRelatedJobsRequest req)` 获取资源关联作业信息
`DescribeResourcesResponse`	`DescribeResources(DescribeResourcesRequest req)` 描述资源接口
`DescribeSystemResourcesResponse`	`DescribeSystemResources(DescribeSystemResourcesRequest req)` 描述系统资源接口
`DescribeTreeJobsResponse`	`DescribeTreeJobs(DescribeTreeJobsRequest req)` 生成树状作业显示结构
`DescribeTreeResourcesResponse`	`DescribeTreeResources(DescribeTreeResourcesRequest req)` 查询树状结构资源列表
`DescribeWorkSpacesResponse`	`DescribeWorkSpaces(DescribeWorkSpacesRequest req)` 授权工作空间列表
`FetchSqlGatewayStatementResultResponse`	`FetchSqlGatewayStatementResult(FetchSqlGatewayStatementResultRequest req)` 查询Sql Gateway的Statement执行结果
`GetMetaTableResponse`	`GetMetaTable(GetMetaTableRequest req)` 查询元数据表
`ModifyFolderResponse`	`ModifyFolder(ModifyFolderRequest req)` 自定义树状结构页面拖拽文件夹
`ModifyJobResponse`	`ModifyJob(ModifyJobRequest req)` 更新作业属性，仅允许以下3种操作，不支持组合操作： (1) 更新作业名称 (2) 更新作业备注 (3) 更新作业最大并行度变更前提：WorkerCuNum<=MaxParallelism 如果MaxParallelism变小，不重启作业，待下一次重启生效如果MaxParallelism变大，则要求入参RestartAllowed必须为True 假设作业运行状态，则先停止作业，再启动作业，中间状态丢失假设作业暂停状态，则将作业更改为停止状态，中间状态丢失
`ModifyWorkSpaceResponse`	`ModifyWorkSpace(ModifyWorkSpaceRequest req)` 修改工作空间
`RunJobsResponse`	`RunJobs(RunJobsRequest req)` 批量启动或者恢复作业，批量操作数量上限20
`RunSqlGatewayStatementResponse`	`RunSqlGatewayStatement(RunSqlGatewayStatementRequest req)` 通过Sql gateway执行satement
`StopJobsResponse`	`StopJobs(StopJobsRequest req)` 批量停止作业，批量操作数量上限为20
`TriggerJobSavepointResponse`	`TriggerJobSavepoint(TriggerJobSavepointRequest req)` 触发Savepoint

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

Constructor Detail

OceanusClient

public OceanusClient(Credential credential,
                     String region)

OceanusClient

public OceanusClient(Credential credential,
                     String region,
                     ClientProfile profile)

Method Detail
- CheckSavepoint
```
public CheckSavepointResponse CheckSavepoint(CheckSavepointRequest req)
                                      throws TencentCloudSDKException
```
  检查快照是否可用
  
  Parameters:
  
  req - CheckSavepointRequest
  
  Returns:
  
  CheckSavepointResponse
  
  Throws:
  
  TencentCloudSDKException
- CopyJobs
```
public CopyJobsResponse CopyJobs(CopyJobsRequest req)
                          throws TencentCloudSDKException
```
  单条和批量复制作业
  
  Parameters:
  
  req - CopyJobsRequest
  
  Returns:
  
  CopyJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateFolder
```
public CreateFolderResponse CreateFolder(CreateFolderRequest req)
                                  throws TencentCloudSDKException
```
  作业列表页面新建文件夹请求
  
  Parameters:
  
  req - CreateFolderRequest
  
  Returns:
  
  CreateFolderResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateJob
```
public CreateJobResponse CreateJob(CreateJobRequest req)
                            throws TencentCloudSDKException
```
  新建作业接口，一个 AppId 最多允许创建1000个作业
  
  Parameters:
  
  req - CreateJobRequest
  
  Returns:
  
  CreateJobResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateJobConfig
```
public CreateJobConfigResponse CreateJobConfig(CreateJobConfigRequest req)
                                        throws TencentCloudSDKException
```
  创建作业配置，一个作业最多有100个配置版本
  
  Parameters:
  
  req - CreateJobConfigRequest
  
  Returns:
  
  CreateJobConfigResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateResource
```
public CreateResourceResponse CreateResource(CreateResourceRequest req)
                                      throws TencentCloudSDKException
```
  创建资源接口
  
  Parameters:
  
  req - CreateResourceRequest
  
  Returns:
  
  CreateResourceResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateResourceConfig
```
public CreateResourceConfigResponse CreateResourceConfig(CreateResourceConfigRequest req)
                                                  throws TencentCloudSDKException
```
  创建资源配置接口
  
  Parameters:
  
  req - CreateResourceConfigRequest
  
  Returns:
  
  CreateResourceConfigResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateWorkSpace
```
public CreateWorkSpaceResponse CreateWorkSpace(CreateWorkSpaceRequest req)
                                        throws TencentCloudSDKException
```
  创建工作空间
  
  Parameters:
  
  req - CreateWorkSpaceRequest
  
  Returns:
  
  CreateWorkSpaceResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteFolders
```
public DeleteFoldersResponse DeleteFolders(DeleteFoldersRequest req)
                                    throws TencentCloudSDKException
```
  作业列表删除文件夹
  
  Parameters:
  
  req - DeleteFoldersRequest
  
  Returns:
  
  DeleteFoldersResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteJobConfigs
```
public DeleteJobConfigsResponse DeleteJobConfigs(DeleteJobConfigsRequest req)
                                          throws TencentCloudSDKException
```
  删除作业配置
  
  Parameters:
  
  req - DeleteJobConfigsRequest
  
  Returns:
  
  DeleteJobConfigsResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteJobs
```
public DeleteJobsResponse DeleteJobs(DeleteJobsRequest req)
                              throws TencentCloudSDKException
```
  批量删除作业接口，批量操作数量上限20
  
  Parameters:
  
  req - DeleteJobsRequest
  
  Returns:
  
  DeleteJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteResourceConfigs
```
public DeleteResourceConfigsResponse DeleteResourceConfigs(DeleteResourceConfigsRequest req)
                                                    throws TencentCloudSDKException
```
  删除资源版本
  
  Parameters:
  
  req - DeleteResourceConfigsRequest
  
  Returns:
  
  DeleteResourceConfigsResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteResources
```
public DeleteResourcesResponse DeleteResources(DeleteResourcesRequest req)
                                        throws TencentCloudSDKException
```
  删除资源接口
  
  Parameters:
  
  req - DeleteResourcesRequest
  
  Returns:
  
  DeleteResourcesResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteTableConfig
```
public DeleteTableConfigResponse DeleteTableConfig(DeleteTableConfigRequest req)
                                            throws TencentCloudSDKException
```
  删除作业表配置
  
  Parameters:
  
  req - DeleteTableConfigRequest
  
  Returns:
  
  DeleteTableConfigResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteWorkSpace
```
public DeleteWorkSpaceResponse DeleteWorkSpace(DeleteWorkSpaceRequest req)
                                        throws TencentCloudSDKException
```
  删除工作空间
  
  Parameters:
  
  req - DeleteWorkSpaceRequest
  
  Returns:
  
  DeleteWorkSpaceResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeClusters
```
public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException
```
  查询集群
  
  Parameters:
  
  req - DescribeClustersRequest
  
  Returns:
  
  DescribeClustersResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeFolder
```
public DescribeFolderResponse DescribeFolder(DescribeFolderRequest req)
                                      throws TencentCloudSDKException
```
  查询指定文件夹及其相应的子文件夹信息
  
  Parameters:
  
  req - DescribeFolderRequest
  
  Returns:
  
  DescribeFolderResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeJobConfigs
```
public DescribeJobConfigsResponse DescribeJobConfigs(DescribeJobConfigsRequest req)
                                              throws TencentCloudSDKException
```
  查询作业配置列表，一次最多查询100个
  
  Parameters:
  
  req - DescribeJobConfigsRequest
  
  Returns:
  
  DescribeJobConfigsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeJobEvents
```
public DescribeJobEventsResponse DescribeJobEvents(DescribeJobEventsRequest req)
                                            throws TencentCloudSDKException
```
  获取指定作业的事件，包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型
  
  Parameters:
  
  req - DescribeJobEventsRequest
  
  Returns:
  
  DescribeJobEventsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeJobRuntimeInfo
```
public DescribeJobRuntimeInfoResponse DescribeJobRuntimeInfo(DescribeJobRuntimeInfoRequest req)
                                                      throws TencentCloudSDKException
```
  获取作业运行时的信息
  
  Parameters:
  
  req - DescribeJobRuntimeInfoRequest
  
  Returns:
  
  DescribeJobRuntimeInfoResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeJobSavepoint
```
public DescribeJobSavepointResponse DescribeJobSavepoint(DescribeJobSavepointRequest req)
                                                  throws TencentCloudSDKException
```
  查找Savepoint列表
  
  Parameters:
  
  req - DescribeJobSavepointRequest
  
  Returns:
  
  DescribeJobSavepointResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeJobSubmissionLog
```
public DescribeJobSubmissionLogResponse DescribeJobSubmissionLog(DescribeJobSubmissionLogRequest req)
                                                          throws TencentCloudSDKException
```
  查询作业实例启动日志
  
  Parameters:
  
  req - DescribeJobSubmissionLogRequest
  
  Returns:
  
  DescribeJobSubmissionLogResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeJobs
```
public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req)
                                  throws TencentCloudSDKException
```
  查询作业
  
  Parameters:
  
  req - DescribeJobsRequest
  
  Returns:
  
  DescribeJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeResourceConfigs
```
public DescribeResourceConfigsResponse DescribeResourceConfigs(DescribeResourceConfigsRequest req)
                                                        throws TencentCloudSDKException
```
  描述资源配置接口
  
  Parameters:
  
  req - DescribeResourceConfigsRequest
  
  Returns:
  
  DescribeResourceConfigsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeResourceRelatedJobs
```
public DescribeResourceRelatedJobsResponse DescribeResourceRelatedJobs(DescribeResourceRelatedJobsRequest req)
                                                                throws TencentCloudSDKException
```
  获取资源关联作业信息
  
  Parameters:
  
  req - DescribeResourceRelatedJobsRequest
  
  Returns:
  
  DescribeResourceRelatedJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeResources
```
public DescribeResourcesResponse DescribeResources(DescribeResourcesRequest req)
                                            throws TencentCloudSDKException
```
  描述资源接口
  
  Parameters:
  
  req - DescribeResourcesRequest
  
  Returns:
  
  DescribeResourcesResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeSystemResources
```
public DescribeSystemResourcesResponse DescribeSystemResources(DescribeSystemResourcesRequest req)
                                                        throws TencentCloudSDKException
```
  描述系统资源接口
  
  Parameters:
  
  req - DescribeSystemResourcesRequest
  
  Returns:
  
  DescribeSystemResourcesResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeTreeJobs
```
public DescribeTreeJobsResponse DescribeTreeJobs(DescribeTreeJobsRequest req)
                                          throws TencentCloudSDKException
```
  生成树状作业显示结构
  
  Parameters:
  
  req - DescribeTreeJobsRequest
  
  Returns:
  
  DescribeTreeJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeTreeResources
```
public DescribeTreeResourcesResponse DescribeTreeResources(DescribeTreeResourcesRequest req)
                                                    throws TencentCloudSDKException
```
  查询树状结构资源列表
  
  Parameters:
  
  req - DescribeTreeResourcesRequest
  
  Returns:
  
  DescribeTreeResourcesResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeWorkSpaces
```
public DescribeWorkSpacesResponse DescribeWorkSpaces(DescribeWorkSpacesRequest req)
                                              throws TencentCloudSDKException
```
  授权工作空间列表
  
  Parameters:
  
  req - DescribeWorkSpacesRequest
  
  Returns:
  
  DescribeWorkSpacesResponse
  
  Throws:
  
  TencentCloudSDKException
- FetchSqlGatewayStatementResult
```
public FetchSqlGatewayStatementResultResponse FetchSqlGatewayStatementResult(FetchSqlGatewayStatementResultRequest req)
                                                                      throws TencentCloudSDKException
```
  查询Sql Gateway的Statement执行结果
  
  Parameters:
  
  req - FetchSqlGatewayStatementResultRequest
  
  Returns:
  
  FetchSqlGatewayStatementResultResponse
  
  Throws:
  
  TencentCloudSDKException
- GetMetaTable
```
public GetMetaTableResponse GetMetaTable(GetMetaTableRequest req)
                                  throws TencentCloudSDKException
```
  查询元数据表
  
  Parameters:
  
  req - GetMetaTableRequest
  
  Returns:
  
  GetMetaTableResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyFolder
```
public ModifyFolderResponse ModifyFolder(ModifyFolderRequest req)
                                  throws TencentCloudSDKException
```
  自定义树状结构页面拖拽文件夹
  
  Parameters:
  
  req - ModifyFolderRequest
  
  Returns:
  
  ModifyFolderResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyJob
```
public ModifyJobResponse ModifyJob(ModifyJobRequest req)
                            throws TencentCloudSDKException
```
  更新作业属性，仅允许以下3种操作，不支持组合操作： (1) 更新作业名称 (2) 更新作业备注 (3) 更新作业最大并行度变更前提：WorkerCuNum<=MaxParallelism 如果MaxParallelism变小，不重启作业，待下一次重启生效如果MaxParallelism变大，则要求入参RestartAllowed必须为True 假设作业运行状态，则先停止作业，再启动作业，中间状态丢失假设作业暂停状态，则将作业更改为停止状态，中间状态丢失
  
  Parameters:
  
  req - ModifyJobRequest
  
  Returns:
  
  ModifyJobResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyWorkSpace
```
public ModifyWorkSpaceResponse ModifyWorkSpace(ModifyWorkSpaceRequest req)
                                        throws TencentCloudSDKException
```
  修改工作空间
  
  Parameters:
  
  req - ModifyWorkSpaceRequest
  
  Returns:
  
  ModifyWorkSpaceResponse
  
  Throws:
  
  TencentCloudSDKException
- RunJobs
```
public RunJobsResponse RunJobs(RunJobsRequest req)
                        throws TencentCloudSDKException
```
  批量启动或者恢复作业，批量操作数量上限20
  
  Parameters:
  
  req - RunJobsRequest
  
  Returns:
  
  RunJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- RunSqlGatewayStatement
```
public RunSqlGatewayStatementResponse RunSqlGatewayStatement(RunSqlGatewayStatementRequest req)
                                                      throws TencentCloudSDKException
```
  通过Sql gateway执行satement
  
  Parameters:
  
  req - RunSqlGatewayStatementRequest
  
  Returns:
  
  RunSqlGatewayStatementResponse
  
  Throws:
  
  TencentCloudSDKException
- StopJobs
```
public StopJobsResponse StopJobs(StopJobsRequest req)
                          throws TencentCloudSDKException
```
  批量停止作业，批量操作数量上限为20
  
  Parameters:
  
  req - StopJobsRequest
  
  Returns:
  
  StopJobsResponse
  
  Throws:
  
  TencentCloudSDKException
- TriggerJobSavepoint
```
public TriggerJobSavepointResponse TriggerJobSavepoint(TriggerJobSavepointRequest req)
                                                throws TencentCloudSDKException
```
  触发Savepoint
  
  Parameters:
  
  req - TriggerJobSavepointRequest
  
  Returns:
  
  TriggerJobSavepointResponse
  
  Throws:
  
  TencentCloudSDKException

Class OceanusClient

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

OceanusClient

OceanusClient

Method Detail

CheckSavepoint

CopyJobs

CreateFolder

CreateJob

CreateJobConfig

CreateResource

CreateResourceConfig

CreateWorkSpace

DeleteFolders

DeleteJobConfigs

DeleteJobs

DeleteResourceConfigs

DeleteResources

DeleteTableConfig

DeleteWorkSpace

DescribeClusters

DescribeFolder

DescribeJobConfigs

DescribeJobEvents

DescribeJobRuntimeInfo

DescribeJobSavepoint

DescribeJobSubmissionLog

DescribeJobs

DescribeResourceConfigs

DescribeResourceRelatedJobs

DescribeResources

DescribeSystemResources

DescribeTreeJobs

DescribeTreeResources

DescribeWorkSpaces

FetchSqlGatewayStatementResult

GetMetaTable

ModifyFolder

ModifyJob

ModifyWorkSpace

RunJobs

RunSqlGatewayStatement

StopJobs

TriggerJobSavepoint