TcaplusdbClient (tencentcloud-sdk-java 3.1.136 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tcaplusdb.v20190823.TcaplusdbClient

public class TcaplusdbClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClearTablesResponse`	`ClearTables(ClearTablesRequest req)` 根据给定的表信息，清除表数据。
`CompareIdlFilesResponse`	`CompareIdlFiles(CompareIdlFilesRequest req)` 选中目标表格，上传并校验改表文件，返回是否允许修改表格结构的结果。
`CreateBackupResponse`	`CreateBackup(CreateBackupRequest req)` 用户创建备份任务
`CreateClusterResponse`	`CreateCluster(CreateClusterRequest req)` 本接口用于创建TcaplusDB集群
`CreateTableGroupResponse`	`CreateTableGroup(CreateTableGroupRequest req)` 在TcaplusDB集群下创建表格组
`CreateTablesResponse`	`CreateTables(CreateTablesRequest req)` 根据选择的IDL文件列表，批量创建表格
`DeleteClusterResponse`	`DeleteCluster(DeleteClusterRequest req)` 删除TcaplusDB集群，必须在集群所属所有资源（包括表格组，表）都已经释放的情况下才会成功。
`DeleteIdlFilesResponse`	`DeleteIdlFiles(DeleteIdlFilesRequest req)` 指定集群ID和待删除IDL文件的信息，删除目标文件，如果文件正在被表关联则删除失败。
`DeleteTableGroupResponse`	`DeleteTableGroup(DeleteTableGroupRequest req)` 删除表格组
`DeleteTableIndexResponse`	`DeleteTableIndex(DeleteTableIndexRequest req)` 删除表格的分布式索引
`DeleteTablesResponse`	`DeleteTables(DeleteTablesRequest req)` 删除指定的表,第一次调用此接口代表将表移动至回收站，再次调用代表将此表格从回收站中彻底删除。
`DescribeClustersResponse`	`DescribeClusters(DescribeClustersRequest req)` 查询TcaplusDB集群列表，包含集群详细信息。
`DescribeClusterTagsResponse`	`DescribeClusterTags(DescribeClusterTagsRequest req)` 获取集群关联的标签列表
`DescribeIdlFileInfosResponse`	`DescribeIdlFileInfos(DescribeIdlFileInfosRequest req)` 查询表描述文件详情
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` 查询TcaplusDB服务支持的地域列表
`DescribeTableGroupsResponse`	`DescribeTableGroups(DescribeTableGroupsRequest req)` 查询表格组列表
`DescribeTableGroupTagsResponse`	`DescribeTableGroupTags(DescribeTableGroupTagsRequest req)` 获取表格组关联的标签列表
`DescribeTablesResponse`	`DescribeTables(DescribeTablesRequest req)` 查询表详情
`DescribeTablesInRecycleResponse`	`DescribeTablesInRecycle(DescribeTablesInRecycleRequest req)` 查询回收站中的表详情
`DescribeTableTagsResponse`	`DescribeTableTags(DescribeTableTagsRequest req)` 获取表格标签
`DescribeTasksResponse`	`DescribeTasks(DescribeTasksRequest req)` 查询任务列表
`DescribeUinInWhitelistResponse`	`DescribeUinInWhitelist(DescribeUinInWhitelistRequest req)` 查询本用户是否在白名单中，控制是否能创建TDR类型的APP或表
`ModifyClusterNameResponse`	`ModifyClusterName(ModifyClusterNameRequest req)` 修改指定的集群名称
`ModifyClusterPasswordResponse`	`ModifyClusterPassword(ModifyClusterPasswordRequest req)` 修改指定集群的密码，后台将在旧密码失效之前同时支持TcaplusDB SDK使用旧密码和新密码访问数据库。在旧密码失效之前不能提交新的密码修改请求，在旧密码失效之后不能提交修改旧密码过期时间的请求。
`ModifyClusterTagsResponse`	`ModifyClusterTags(ModifyClusterTagsRequest req)` 修改集群标签
`ModifyTableGroupNameResponse`	`ModifyTableGroupName(ModifyTableGroupNameRequest req)` 修改TcaplusDB表格组名称
`ModifyTableGroupTagsResponse`	`ModifyTableGroupTags(ModifyTableGroupTagsRequest req)` 修改表格组标签
`ModifyTableMemosResponse`	`ModifyTableMemos(ModifyTableMemosRequest req)` 修改表备注信息
`ModifyTableQuotasResponse`	`ModifyTableQuotas(ModifyTableQuotasRequest req)` 表格扩缩容
`ModifyTablesResponse`	`ModifyTables(ModifyTablesRequest req)` 根据用户选定的表定义IDL文件，批量修改指定的表
`ModifyTableTagsResponse`	`ModifyTableTags(ModifyTableTagsRequest req)` 修改表格标签
`RecoverRecycleTablesResponse`	`RecoverRecycleTables(RecoverRecycleTablesRequest req)` 恢复回收站中，用户自行删除的表。对欠费待释放的表无效。
`RollbackTablesResponse`	`RollbackTables(RollbackTablesRequest req)` 表格数据回档
`SetTableIndexResponse`	`SetTableIndex(SetTableIndexRequest req)` 设置表格分布式索引
`VerifyIdlFilesResponse`	`VerifyIdlFiles(VerifyIdlFilesRequest req)` 上传并校验创建表格文件，返回校验合法的表格定义

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, 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
  - TcaplusdbClient
```
public TcaplusdbClient(Credential credential,
                       String region)
```
  - TcaplusdbClient
```
public TcaplusdbClient(Credential credential,
                       String region,
                       ClientProfile profile)
```
- Method Detail
  - ClearTables
```
public ClearTablesResponse ClearTables(ClearTablesRequest req)
                                throws TencentCloudSDKException
```
    根据给定的表信息，清除表数据。
    
    Parameters:
    
    req - ClearTablesRequest
    
    Returns:
    
    ClearTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CompareIdlFiles
```
public CompareIdlFilesResponse CompareIdlFiles(CompareIdlFilesRequest req)
                                        throws TencentCloudSDKException
```
    选中目标表格，上传并校验改表文件，返回是否允许修改表格结构的结果。
    
    Parameters:
    
    req - CompareIdlFilesRequest
    
    Returns:
    
    CompareIdlFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBackup
```
public CreateBackupResponse CreateBackup(CreateBackupRequest req)
                                  throws TencentCloudSDKException
```
    用户创建备份任务
    
    Parameters:
    
    req - CreateBackupRequest
    
    Returns:
    
    CreateBackupResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCluster
```
public CreateClusterResponse CreateCluster(CreateClusterRequest req)
                                    throws TencentCloudSDKException
```
    本接口用于创建TcaplusDB集群
    
    Parameters:
    
    req - CreateClusterRequest
    
    Returns:
    
    CreateClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTableGroup
```
public CreateTableGroupResponse CreateTableGroup(CreateTableGroupRequest req)
                                          throws TencentCloudSDKException
```
    在TcaplusDB集群下创建表格组
    
    Parameters:
    
    req - CreateTableGroupRequest
    
    Returns:
    
    CreateTableGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTables
```
public CreateTablesResponse CreateTables(CreateTablesRequest req)
                                  throws TencentCloudSDKException
```
    根据选择的IDL文件列表，批量创建表格
    
    Parameters:
    
    req - CreateTablesRequest
    
    Returns:
    
    CreateTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCluster
```
public DeleteClusterResponse DeleteCluster(DeleteClusterRequest req)
                                    throws TencentCloudSDKException
```
    删除TcaplusDB集群，必须在集群所属所有资源（包括表格组，表）都已经释放的情况下才会成功。
    
    Parameters:
    
    req - DeleteClusterRequest
    
    Returns:
    
    DeleteClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIdlFiles
```
public DeleteIdlFilesResponse DeleteIdlFiles(DeleteIdlFilesRequest req)
                                      throws TencentCloudSDKException
```
    指定集群ID和待删除IDL文件的信息，删除目标文件，如果文件正在被表关联则删除失败。
    
    Parameters:
    
    req - DeleteIdlFilesRequest
    
    Returns:
    
    DeleteIdlFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTableGroup
```
public DeleteTableGroupResponse DeleteTableGroup(DeleteTableGroupRequest req)
                                          throws TencentCloudSDKException
```
    删除表格组
    
    Parameters:
    
    req - DeleteTableGroupRequest
    
    Returns:
    
    DeleteTableGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTableIndex
```
public DeleteTableIndexResponse DeleteTableIndex(DeleteTableIndexRequest req)
                                          throws TencentCloudSDKException
```
    删除表格的分布式索引
    
    Parameters:
    
    req - DeleteTableIndexRequest
    
    Returns:
    
    DeleteTableIndexResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTables
```
public DeleteTablesResponse DeleteTables(DeleteTablesRequest req)
                                  throws TencentCloudSDKException
```
    删除指定的表,第一次调用此接口代表将表移动至回收站，再次调用代表将此表格从回收站中彻底删除。
    
    Parameters:
    
    req - DeleteTablesRequest
    
    Returns:
    
    DeleteTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterTags
```
public DescribeClusterTagsResponse DescribeClusterTags(DescribeClusterTagsRequest req)
                                                throws TencentCloudSDKException
```
    获取集群关联的标签列表
    
    Parameters:
    
    req - DescribeClusterTagsRequest
    
    Returns:
    
    DescribeClusterTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusters
```
public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException
```
    查询TcaplusDB集群列表，包含集群详细信息。
    
    Parameters:
    
    req - DescribeClustersRequest
    
    Returns:
    
    DescribeClustersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIdlFileInfos
```
public DescribeIdlFileInfosResponse DescribeIdlFileInfos(DescribeIdlFileInfosRequest req)
                                                  throws TencentCloudSDKException
```
    查询表描述文件详情
    
    Parameters:
    
    req - DescribeIdlFileInfosRequest
    
    Returns:
    
    DescribeIdlFileInfosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRegions
```
public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException
```
    查询TcaplusDB服务支持的地域列表
    
    Parameters:
    
    req - DescribeRegionsRequest
    
    Returns:
    
    DescribeRegionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTableGroupTags
```
public DescribeTableGroupTagsResponse DescribeTableGroupTags(DescribeTableGroupTagsRequest req)
                                                      throws TencentCloudSDKException
```
    获取表格组关联的标签列表
    
    Parameters:
    
    req - DescribeTableGroupTagsRequest
    
    Returns:
    
    DescribeTableGroupTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTableGroups
```
public DescribeTableGroupsResponse DescribeTableGroups(DescribeTableGroupsRequest req)
                                                throws TencentCloudSDKException
```
    查询表格组列表
    
    Parameters:
    
    req - DescribeTableGroupsRequest
    
    Returns:
    
    DescribeTableGroupsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTableTags
```
public DescribeTableTagsResponse DescribeTableTags(DescribeTableTagsRequest req)
                                            throws TencentCloudSDKException
```
    获取表格标签
    
    Parameters:
    
    req - DescribeTableTagsRequest
    
    Returns:
    
    DescribeTableTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTables
```
public DescribeTablesResponse DescribeTables(DescribeTablesRequest req)
                                      throws TencentCloudSDKException
```
    查询表详情
    
    Parameters:
    
    req - DescribeTablesRequest
    
    Returns:
    
    DescribeTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTablesInRecycle
```
public DescribeTablesInRecycleResponse DescribeTablesInRecycle(DescribeTablesInRecycleRequest req)
                                                        throws TencentCloudSDKException
```
    查询回收站中的表详情
    
    Parameters:
    
    req - DescribeTablesInRecycleRequest
    
    Returns:
    
    DescribeTablesInRecycleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTasks
```
public DescribeTasksResponse DescribeTasks(DescribeTasksRequest req)
                                    throws TencentCloudSDKException
```
    查询任务列表
    
    Parameters:
    
    req - DescribeTasksRequest
    
    Returns:
    
    DescribeTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUinInWhitelist
```
public DescribeUinInWhitelistResponse DescribeUinInWhitelist(DescribeUinInWhitelistRequest req)
                                                      throws TencentCloudSDKException
```
    查询本用户是否在白名单中，控制是否能创建TDR类型的APP或表
    
    Parameters:
    
    req - DescribeUinInWhitelistRequest
    
    Returns:
    
    DescribeUinInWhitelistResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClusterName
```
public ModifyClusterNameResponse ModifyClusterName(ModifyClusterNameRequest req)
                                            throws TencentCloudSDKException
```
    修改指定的集群名称
    
    Parameters:
    
    req - ModifyClusterNameRequest
    
    Returns:
    
    ModifyClusterNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClusterPassword
```
public ModifyClusterPasswordResponse ModifyClusterPassword(ModifyClusterPasswordRequest req)
                                                    throws TencentCloudSDKException
```
    修改指定集群的密码，后台将在旧密码失效之前同时支持TcaplusDB SDK使用旧密码和新密码访问数据库。在旧密码失效之前不能提交新的密码修改请求，在旧密码失效之后不能提交修改旧密码过期时间的请求。
    
    Parameters:
    
    req - ModifyClusterPasswordRequest
    
    Returns:
    
    ModifyClusterPasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyClusterTags
```
public ModifyClusterTagsResponse ModifyClusterTags(ModifyClusterTagsRequest req)
                                            throws TencentCloudSDKException
```
    修改集群标签
    
    Parameters:
    
    req - ModifyClusterTagsRequest
    
    Returns:
    
    ModifyClusterTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTableGroupName
```
public ModifyTableGroupNameResponse ModifyTableGroupName(ModifyTableGroupNameRequest req)
                                                  throws TencentCloudSDKException
```
    修改TcaplusDB表格组名称
    
    Parameters:
    
    req - ModifyTableGroupNameRequest
    
    Returns:
    
    ModifyTableGroupNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTableGroupTags
```
public ModifyTableGroupTagsResponse ModifyTableGroupTags(ModifyTableGroupTagsRequest req)
                                                  throws TencentCloudSDKException
```
    修改表格组标签
    
    Parameters:
    
    req - ModifyTableGroupTagsRequest
    
    Returns:
    
    ModifyTableGroupTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTableMemos
```
public ModifyTableMemosResponse ModifyTableMemos(ModifyTableMemosRequest req)
                                          throws TencentCloudSDKException
```
    修改表备注信息
    
    Parameters:
    
    req - ModifyTableMemosRequest
    
    Returns:
    
    ModifyTableMemosResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTableQuotas
```
public ModifyTableQuotasResponse ModifyTableQuotas(ModifyTableQuotasRequest req)
                                            throws TencentCloudSDKException
```
    表格扩缩容
    
    Parameters:
    
    req - ModifyTableQuotasRequest
    
    Returns:
    
    ModifyTableQuotasResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTableTags
```
public ModifyTableTagsResponse ModifyTableTags(ModifyTableTagsRequest req)
                                        throws TencentCloudSDKException
```
    修改表格标签
    
    Parameters:
    
    req - ModifyTableTagsRequest
    
    Returns:
    
    ModifyTableTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTables
```
public ModifyTablesResponse ModifyTables(ModifyTablesRequest req)
                                  throws TencentCloudSDKException
```
    根据用户选定的表定义IDL文件，批量修改指定的表
    
    Parameters:
    
    req - ModifyTablesRequest
    
    Returns:
    
    ModifyTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RecoverRecycleTables
```
public RecoverRecycleTablesResponse RecoverRecycleTables(RecoverRecycleTablesRequest req)
                                                  throws TencentCloudSDKException
```
    恢复回收站中，用户自行删除的表。对欠费待释放的表无效。
    
    Parameters:
    
    req - RecoverRecycleTablesRequest
    
    Returns:
    
    RecoverRecycleTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RollbackTables
```
public RollbackTablesResponse RollbackTables(RollbackTablesRequest req)
                                      throws TencentCloudSDKException
```
    表格数据回档
    
    Parameters:
    
    req - RollbackTablesRequest
    
    Returns:
    
    RollbackTablesResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetTableIndex
```
public SetTableIndexResponse SetTableIndex(SetTableIndexRequest req)
                                    throws TencentCloudSDKException
```
    设置表格分布式索引
    
    Parameters:
    
    req - SetTableIndexRequest
    
    Returns:
    
    SetTableIndexResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifyIdlFiles
```
public VerifyIdlFilesResponse VerifyIdlFiles(VerifyIdlFilesRequest req)
                                      throws TencentCloudSDKException
```
    上传并校验创建表格文件，返回校验合法的表格定义
    
    Parameters:
    
    req - VerifyIdlFilesRequest
    
    Returns:
    
    VerifyIdlFilesResponse
    
    Throws:
    
    TencentCloudSDKException

Class TcaplusdbClient

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

TcaplusdbClient

TcaplusdbClient

Method Detail

ClearTables

CompareIdlFiles

CreateBackup

CreateCluster

CreateTableGroup

CreateTables

DeleteCluster

DeleteIdlFiles

DeleteTableGroup

DeleteTableIndex

DeleteTables

DescribeClusterTags

DescribeClusters

DescribeIdlFileInfos

DescribeRegions

DescribeTableGroupTags

DescribeTableGroups

DescribeTableTags

DescribeTables

DescribeTablesInRecycle

DescribeTasks

DescribeUinInWhitelist

ModifyClusterName

ModifyClusterPassword

ModifyClusterTags

ModifyTableGroupName

ModifyTableGroupTags

ModifyTableMemos

ModifyTableQuotas

ModifyTableTags

ModifyTables

RecoverRecycleTables

RollbackTables

SetTableIndex

VerifyIdlFiles