com.tencentcloudapi.tcaplusdb.v20190823

Class TcaplusdbClient

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

Modifier and Type	Method and Description
ClearTablesResponse	ClearTables(ClearTablesRequest req) This API is used to clear table data based on the specified table information.
CompareIdlFilesResponse	CompareIdlFiles(CompareIdlFilesRequest req) This API is used to select a target table, upload and verify the table modification file, and return the result of whether the table structure is allowed to be modified.
CreateBackupResponse	CreateBackup(CreateBackupRequest req) This API is used to create a backup task.
CreateClusterResponse	CreateCluster(CreateClusterRequest req) This API is used to create a TcaplusDB cluster.
CreateSnapshotsResponse	CreateSnapshots(CreateSnapshotsRequest req) This API is used to create one or more table snapshots at a specified past time point.
CreateTableGroupResponse	CreateTableGroup(CreateTableGroupRequest req) This API is used to create a table group in a TcaplusDB cluster.
CreateTablesResponse	CreateTables(CreateTablesRequest req) This API is used to create tables in batches based on the selected IDL file list.
DeleteClusterResponse	DeleteCluster(DeleteClusterRequest req) This API is used to delete a TcaplusDB cluster, which will succeed only after all resources (including table groups and tables) in the cluster are released.
DeleteIdlFilesResponse	DeleteIdlFiles(DeleteIdlFilesRequest req) This API is used to delete a target IDL file by specifying the cluster ID and information of the file to be deleted.
DeleteSnapshotsResponse	DeleteSnapshots(DeleteSnapshotsRequest req) This API is used to delete one or more table snapshots.
DeleteTableDataFlowResponse	DeleteTableDataFlow(DeleteTableDataFlowRequest req) This API is used to disable data subscription for tables.
DeleteTableGroupResponse	DeleteTableGroup(DeleteTableGroupRequest req) This API is used to delete a table group.
DeleteTableIndexResponse	DeleteTableIndex(DeleteTableIndexRequest req) This API is used to delete the global index from a table.
DeleteTablesResponse	DeleteTables(DeleteTablesRequest req) This API is used to drop a specified table.
DescribeClustersResponse	DescribeClusters(DescribeClustersRequest req) This API is used to query the TcaplusDB cluster list, including cluster details.
DescribeClusterTagsResponse	DescribeClusterTags(DescribeClusterTagsRequest req) This API is used to get the associated tag list of a cluster.
DescribeIdlFileInfosResponse	DescribeIdlFileInfos(DescribeIdlFileInfosRequest req) This API is used to query table description file details.
DescribeMachineResponse	DescribeMachine(DescribeMachineRequest req) This API is used to query the available machines in a dedicated cluster.
DescribeRegionsResponse	DescribeRegions(DescribeRegionsRequest req) This API is used to query the list of regions supported by the TcaplusDB service.
DescribeSnapshotsResponse	DescribeSnapshots(DescribeSnapshotsRequest req) This API is used to query the list of table snapshots.
DescribeTableGroupsResponse	DescribeTableGroups(DescribeTableGroupsRequest req) This API is used to query the table group list.
DescribeTableGroupTagsResponse	DescribeTableGroupTags(DescribeTableGroupTagsRequest req) This API is used to get the associated tag list of a table group.
DescribeTablesResponse	DescribeTables(DescribeTablesRequest req) This API is used to query table details.
DescribeTablesInRecycleResponse	DescribeTablesInRecycle(DescribeTablesInRecycleRequest req) This API is used to query the details of a table in recycle bin.
DescribeTableTagsResponse	DescribeTableTags(DescribeTableTagsRequest req) This API is used to get table tags.
DescribeTasksResponse	DescribeTasks(DescribeTasksRequest req) This API is used to query the task list.
DescribeUinInWhitelistResponse	DescribeUinInWhitelist(DescribeUinInWhitelistRequest req) This API is used to query whether the current user is in the allowlist and control whether the user can create TDR-type apps or tables.
DisableRestProxyResponse	DisableRestProxy(DisableRestProxyRequest req) This API is used to disable the RESTful API.
EnableRestProxyResponse	EnableRestProxy(EnableRestProxyRequest req) This API is used to enable the RESTful API.
ImportSnapshotsResponse	ImportSnapshots(ImportSnapshotsRequest req) This API is used to import a snapshot into a new table or the original table from which the snapshot was created.
MergeTablesDataResponse	MergeTablesData(MergeTablesDataRequest req) This API is used to merge tables.
ModifyCensorshipResponse	ModifyCensorship(ModifyCensorshipRequest req) This API is used to enable or disable the cluster operation approval feature.
ModifyClusterMachineResponse	ModifyClusterMachine(ModifyClusterMachineRequest req) This API is used to modify the machines of a dedicated cluster.
ModifyClusterNameResponse	ModifyClusterName(ModifyClusterNameRequest req) This API is used to rename a specified cluster.
ModifyClusterPasswordResponse	ModifyClusterPassword(ModifyClusterPasswordRequest req) This API is used to change the password of a specified cluster.
ModifyClusterTagsResponse	ModifyClusterTags(ModifyClusterTagsRequest req) This API is used to modify cluster tags.
ModifySnapshotsResponse	ModifySnapshots(ModifySnapshotsRequest req) This API is used to modify the expiration time of one or more table snapshots.
ModifyTableGroupNameResponse	ModifyTableGroupName(ModifyTableGroupNameRequest req) This API is used to rename a TcaplusDB table group.
ModifyTableGroupTagsResponse	ModifyTableGroupTags(ModifyTableGroupTagsRequest req) This API is used to modify table group tags.
ModifyTableMemosResponse	ModifyTableMemos(ModifyTableMemosRequest req) This API is used to modify table remarks.
ModifyTableQuotasResponse	ModifyTableQuotas(ModifyTableQuotasRequest req) This API is used to scale a table.
ModifyTablesResponse	ModifyTables(ModifyTablesRequest req) This API is used to modify specified tables in batches based on the selected table definition IDL file.
ModifyTableTagsResponse	ModifyTableTags(ModifyTableTagsRequest req) This API is used to modify table tags.
RecoverRecycleTablesResponse	RecoverRecycleTables(RecoverRecycleTablesRequest req) This API is used to recover a dropped table from the recycle bin.
RollbackTablesResponse	RollbackTables(RollbackTablesRequest req) This API is used to roll back table data.
SetTableDataFlowResponse	SetTableDataFlow(SetTableDataFlowRequest req) This API is used to enable data subscription for tables or modify the feature's configurations.
SetTableIndexResponse	SetTableIndex(SetTableIndexRequest req) This API is used to create a global index for a table.
UpdateApplyResponse	UpdateApply(UpdateApplyRequest req) This API is used to update the application status.
VerifyIdlFilesResponse	VerifyIdlFiles(VerifyIdlFilesRequest req) This API is used to upload and verify a table creation file and return the definition of tables that are verified to be valid.

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

This API is used to clear table data based on the specified table information.

Parameters:

req - ClearTablesRequest

Returns:

ClearTablesResponse

Throws:

TencentCloudSDKException

CompareIdlFiles

public CompareIdlFilesResponse CompareIdlFiles(CompareIdlFilesRequest req)
                                        throws TencentCloudSDKException

This API is used to select a target table, upload and verify the table modification file, and return the result of whether the table structure is allowed to be modified.

Parameters:

req - CompareIdlFilesRequest

Returns:

CompareIdlFilesResponse

Throws:

TencentCloudSDKException

CreateBackup

public CreateBackupResponse CreateBackup(CreateBackupRequest req)
                                  throws TencentCloudSDKException

This API is used to create a backup task.

Parameters:

req - CreateBackupRequest

Returns:

CreateBackupResponse

Throws:

TencentCloudSDKException

CreateCluster

public CreateClusterResponse CreateCluster(CreateClusterRequest req)
                                    throws TencentCloudSDKException

This API is used to create a TcaplusDB cluster.

Parameters:

req - CreateClusterRequest

Returns:

CreateClusterResponse

Throws:

TencentCloudSDKException

CreateSnapshots

public CreateSnapshotsResponse CreateSnapshots(CreateSnapshotsRequest req)
                                        throws TencentCloudSDKException

This API is used to create one or more table snapshots at a specified past time point.

Parameters:

req - CreateSnapshotsRequest

Returns:

CreateSnapshotsResponse

Throws:

TencentCloudSDKException

CreateTableGroup

public CreateTableGroupResponse CreateTableGroup(CreateTableGroupRequest req)
                                          throws TencentCloudSDKException

This API is used to create a table group in a TcaplusDB cluster.

Parameters:

req - CreateTableGroupRequest

Returns:

CreateTableGroupResponse

Throws:

TencentCloudSDKException

CreateTables

public CreateTablesResponse CreateTables(CreateTablesRequest req)
                                  throws TencentCloudSDKException

This API is used to create tables in batches based on the selected IDL file list.

Parameters:

req - CreateTablesRequest

Returns:

CreateTablesResponse

Throws:

TencentCloudSDKException

DeleteCluster

public DeleteClusterResponse DeleteCluster(DeleteClusterRequest req)
                                    throws TencentCloudSDKException

This API is used to delete a TcaplusDB cluster, which will succeed only after all resources (including table groups and tables) in the cluster are released.

Parameters:

req - DeleteClusterRequest

Returns:

DeleteClusterResponse

Throws:

TencentCloudSDKException

DeleteIdlFiles

public DeleteIdlFilesResponse DeleteIdlFiles(DeleteIdlFilesRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a target IDL file by specifying the cluster ID and information of the file to be deleted. If the file is associated with a table, deletion will fail.

Parameters:

req - DeleteIdlFilesRequest

Returns:

DeleteIdlFilesResponse

Throws:

TencentCloudSDKException

DeleteSnapshots

public DeleteSnapshotsResponse DeleteSnapshots(DeleteSnapshotsRequest req)
                                        throws TencentCloudSDKException

This API is used to delete one or more table snapshots.

Parameters:

req - DeleteSnapshotsRequest

Returns:

DeleteSnapshotsResponse

Throws:

TencentCloudSDKException

DeleteTableDataFlow

public DeleteTableDataFlowResponse DeleteTableDataFlow(DeleteTableDataFlowRequest req)
                                                throws TencentCloudSDKException

This API is used to disable data subscription for tables.

Parameters:

req - DeleteTableDataFlowRequest

Returns:

DeleteTableDataFlowResponse

Throws:

TencentCloudSDKException

DeleteTableGroup

public DeleteTableGroupResponse DeleteTableGroup(DeleteTableGroupRequest req)
                                          throws TencentCloudSDKException

This API is used to delete a table group.

Parameters:

req - DeleteTableGroupRequest

Returns:

DeleteTableGroupResponse

Throws:

TencentCloudSDKException

DeleteTableIndex

public DeleteTableIndexResponse DeleteTableIndex(DeleteTableIndexRequest req)
                                          throws TencentCloudSDKException

This API is used to delete the global index from a table.

Parameters:

req - DeleteTableIndexRequest

Returns:

DeleteTableIndexResponse

Throws:

TencentCloudSDKException

DeleteTables

public DeleteTablesResponse DeleteTables(DeleteTablesRequest req)
                                  throws TencentCloudSDKException

This API is used to drop a specified table. Calling this API for the first time means to move the table to the recycle bin, while calling it again means to drop the table completely from the recycle bin.

Parameters:

req - DeleteTablesRequest

Returns:

DeleteTablesResponse

Throws:

TencentCloudSDKException

DescribeClusterTags

public DescribeClusterTagsResponse DescribeClusterTags(DescribeClusterTagsRequest req)
                                                throws TencentCloudSDKException

This API is used to get the associated tag list of a cluster.

Parameters:

req - DescribeClusterTagsRequest

Returns:

DescribeClusterTagsResponse

Throws:

TencentCloudSDKException

DescribeClusters

public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException

This API is used to query the TcaplusDB cluster list, including cluster details.

Parameters:

req - DescribeClustersRequest

Returns:

DescribeClustersResponse

Throws:

TencentCloudSDKException

DescribeIdlFileInfos

public DescribeIdlFileInfosResponse DescribeIdlFileInfos(DescribeIdlFileInfosRequest req)
                                                  throws TencentCloudSDKException

This API is used to query table description file details.

Parameters:

req - DescribeIdlFileInfosRequest

Returns:

DescribeIdlFileInfosResponse

Throws:

TencentCloudSDKException

DescribeMachine

public DescribeMachineResponse DescribeMachine(DescribeMachineRequest req)
                                        throws TencentCloudSDKException

This API is used to query the available machines in a dedicated cluster.

Parameters:

req - DescribeMachineRequest

Returns:

DescribeMachineResponse

Throws:

TencentCloudSDKException

DescribeRegions

public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException

This API is used to query the list of regions supported by the TcaplusDB service.

Parameters:

req - DescribeRegionsRequest

Returns:

DescribeRegionsResponse

Throws:

TencentCloudSDKException

DescribeSnapshots

public DescribeSnapshotsResponse DescribeSnapshots(DescribeSnapshotsRequest req)
                                            throws TencentCloudSDKException

This API is used to query the list of table snapshots.

Parameters:

req - DescribeSnapshotsRequest

Returns:

DescribeSnapshotsResponse

Throws:

TencentCloudSDKException

DescribeTableGroupTags

public DescribeTableGroupTagsResponse DescribeTableGroupTags(DescribeTableGroupTagsRequest req)
                                                      throws TencentCloudSDKException

This API is used to get the associated tag list of a table group.

Parameters:

req - DescribeTableGroupTagsRequest

Returns:

DescribeTableGroupTagsResponse

Throws:

TencentCloudSDKException

DescribeTableGroups

public DescribeTableGroupsResponse DescribeTableGroups(DescribeTableGroupsRequest req)
                                                throws TencentCloudSDKException

This API is used to query the table group list.

Parameters:

req - DescribeTableGroupsRequest

Returns:

DescribeTableGroupsResponse

Throws:

TencentCloudSDKException

DescribeTableTags

public DescribeTableTagsResponse DescribeTableTags(DescribeTableTagsRequest req)
                                            throws TencentCloudSDKException

This API is used to get table tags.

Parameters:

req - DescribeTableTagsRequest

Returns:

DescribeTableTagsResponse

Throws:

TencentCloudSDKException

DescribeTables

public DescribeTablesResponse DescribeTables(DescribeTablesRequest req)
                                      throws TencentCloudSDKException

This API is used to query table details.

Parameters:

req - DescribeTablesRequest

Returns:

DescribeTablesResponse

Throws:

TencentCloudSDKException

DescribeTablesInRecycle

public DescribeTablesInRecycleResponse DescribeTablesInRecycle(DescribeTablesInRecycleRequest req)
                                                        throws TencentCloudSDKException

This API is used to query the details of a table in recycle bin.

Parameters:

req - DescribeTablesInRecycleRequest

Returns:

DescribeTablesInRecycleResponse

Throws:

TencentCloudSDKException

DescribeTasks

public DescribeTasksResponse DescribeTasks(DescribeTasksRequest req)
                                    throws TencentCloudSDKException

This API is used to query the task list.

Parameters:

req - DescribeTasksRequest

Returns:

DescribeTasksResponse

Throws:

TencentCloudSDKException

DescribeUinInWhitelist

public DescribeUinInWhitelistResponse DescribeUinInWhitelist(DescribeUinInWhitelistRequest req)
                                                      throws TencentCloudSDKException

This API is used to query whether the current user is in the allowlist and control whether the user can create TDR-type apps or tables.

Parameters:

req - DescribeUinInWhitelistRequest

Returns:

DescribeUinInWhitelistResponse

Throws:

TencentCloudSDKException

DisableRestProxy

public DisableRestProxyResponse DisableRestProxy(DisableRestProxyRequest req)
                                          throws TencentCloudSDKException

This API is used to disable the RESTful API.

Parameters:

req - DisableRestProxyRequest

Returns:

DisableRestProxyResponse

Throws:

TencentCloudSDKException

EnableRestProxy

public EnableRestProxyResponse EnableRestProxy(EnableRestProxyRequest req)
                                        throws TencentCloudSDKException

This API is used to enable the RESTful API.

Parameters:

req - EnableRestProxyRequest

Returns:

EnableRestProxyResponse

Throws:

TencentCloudSDKException

ImportSnapshots

public ImportSnapshotsResponse ImportSnapshots(ImportSnapshotsRequest req)
                                        throws TencentCloudSDKException

This API is used to import a snapshot into a new table or the original table from which the snapshot was created.

Parameters:

req - ImportSnapshotsRequest

Returns:

ImportSnapshotsResponse

Throws:

TencentCloudSDKException

MergeTablesData

public MergeTablesDataResponse MergeTablesData(MergeTablesDataRequest req)
                                        throws TencentCloudSDKException

This API is used to merge tables.

Parameters:

req - MergeTablesDataRequest

Returns:

MergeTablesDataResponse

Throws:

TencentCloudSDKException

ModifyCensorship

public ModifyCensorshipResponse ModifyCensorship(ModifyCensorshipRequest req)
                                          throws TencentCloudSDKException

This API is used to enable or disable the cluster operation approval feature.

Parameters:

req - ModifyCensorshipRequest

Returns:

ModifyCensorshipResponse

Throws:

TencentCloudSDKException

ModifyClusterMachine

public ModifyClusterMachineResponse ModifyClusterMachine(ModifyClusterMachineRequest req)
                                                  throws TencentCloudSDKException

This API is used to modify the machines of a dedicated cluster.

Parameters:

req - ModifyClusterMachineRequest

Returns:

ModifyClusterMachineResponse

Throws:

TencentCloudSDKException

ModifyClusterName

public ModifyClusterNameResponse ModifyClusterName(ModifyClusterNameRequest req)
                                            throws TencentCloudSDKException

This API is used to rename a specified cluster.

Parameters:

req - ModifyClusterNameRequest

Returns:

ModifyClusterNameResponse

Throws:

TencentCloudSDKException

ModifyClusterPassword

public ModifyClusterPasswordResponse ModifyClusterPassword(ModifyClusterPasswordRequest req)
                                                    throws TencentCloudSDKException

This API is used to change the password of a specified cluster. The backend will allow the TcaplusDB SDK to access databases with both old and new passwords before the old password expires. You cannot submit a new password change request before the old password expires or submit a request to modify the expiration time of the old password after the old password expires.

Parameters:

req - ModifyClusterPasswordRequest

Returns:

ModifyClusterPasswordResponse

Throws:

TencentCloudSDKException

ModifyClusterTags

public ModifyClusterTagsResponse ModifyClusterTags(ModifyClusterTagsRequest req)
                                            throws TencentCloudSDKException

This API is used to modify cluster tags.

Parameters:

req - ModifyClusterTagsRequest

Returns:

ModifyClusterTagsResponse

Throws:

TencentCloudSDKException

ModifySnapshots

public ModifySnapshotsResponse ModifySnapshots(ModifySnapshotsRequest req)
                                        throws TencentCloudSDKException

This API is used to modify the expiration time of one or more table snapshots.

Parameters:

req - ModifySnapshotsRequest

Returns:

ModifySnapshotsResponse

Throws:

TencentCloudSDKException

ModifyTableGroupName

public ModifyTableGroupNameResponse ModifyTableGroupName(ModifyTableGroupNameRequest req)
                                                  throws TencentCloudSDKException

This API is used to rename a TcaplusDB table group.

Parameters:

req - ModifyTableGroupNameRequest

Returns:

ModifyTableGroupNameResponse

Throws:

TencentCloudSDKException

ModifyTableGroupTags

public ModifyTableGroupTagsResponse ModifyTableGroupTags(ModifyTableGroupTagsRequest req)
                                                  throws TencentCloudSDKException

This API is used to modify table group tags.

Parameters:

req - ModifyTableGroupTagsRequest

Returns:

ModifyTableGroupTagsResponse

Throws:

TencentCloudSDKException

ModifyTableMemos

public ModifyTableMemosResponse ModifyTableMemos(ModifyTableMemosRequest req)
                                          throws TencentCloudSDKException

This API is used to modify table remarks.

Parameters:

req - ModifyTableMemosRequest

Returns:

ModifyTableMemosResponse

Throws:

TencentCloudSDKException

ModifyTableQuotas

public ModifyTableQuotasResponse ModifyTableQuotas(ModifyTableQuotasRequest req)
                                            throws TencentCloudSDKException

This API is used to scale a table.

Parameters:

req - ModifyTableQuotasRequest

Returns:

ModifyTableQuotasResponse

Throws:

TencentCloudSDKException

ModifyTableTags

public ModifyTableTagsResponse ModifyTableTags(ModifyTableTagsRequest req)
                                        throws TencentCloudSDKException

This API is used to modify table tags.

Parameters:

req - ModifyTableTagsRequest

Returns:

ModifyTableTagsResponse

Throws:

TencentCloudSDKException

ModifyTables

public ModifyTablesResponse ModifyTables(ModifyTablesRequest req)
                                  throws TencentCloudSDKException

This API is used to modify specified tables in batches based on the selected table definition IDL file.

Parameters:

req - ModifyTablesRequest

Returns:

ModifyTablesResponse

Throws:

TencentCloudSDKException

RecoverRecycleTables

public RecoverRecycleTablesResponse RecoverRecycleTables(RecoverRecycleTablesRequest req)
                                                  throws TencentCloudSDKException

This API is used to recover a dropped table from the recycle bin. It will not work for tables to be released due to arrears.

Parameters:

req - RecoverRecycleTablesRequest

Returns:

RecoverRecycleTablesResponse

Throws:

TencentCloudSDKException

RollbackTables

public RollbackTablesResponse RollbackTables(RollbackTablesRequest req)
                                      throws TencentCloudSDKException

This API is used to roll back table data.

Parameters:

req - RollbackTablesRequest

Returns:

RollbackTablesResponse

Throws:

TencentCloudSDKException

SetTableDataFlow

public SetTableDataFlowResponse SetTableDataFlow(SetTableDataFlowRequest req)
                                          throws TencentCloudSDKException

This API is used to enable data subscription for tables or modify the feature's configurations.

Parameters:

req - SetTableDataFlowRequest

Returns:

SetTableDataFlowResponse

Throws:

TencentCloudSDKException

SetTableIndex

public SetTableIndexResponse SetTableIndex(SetTableIndexRequest req)
                                    throws TencentCloudSDKException

This API is used to create a global index for a table.

Parameters:

req - SetTableIndexRequest

Returns:

SetTableIndexResponse

Throws:

TencentCloudSDKException

UpdateApply

public UpdateApplyResponse UpdateApply(UpdateApplyRequest req)
                                throws TencentCloudSDKException

This API is used to update the application status.

Parameters:

req - UpdateApplyRequest

Returns:

UpdateApplyResponse

Throws:

TencentCloudSDKException

VerifyIdlFiles

public VerifyIdlFilesResponse VerifyIdlFiles(VerifyIdlFilesRequest req)
                                      throws TencentCloudSDKException

This API is used to upload and verify a table creation file and return the definition of tables that are verified to be valid.

Parameters:

req - VerifyIdlFilesRequest

Returns:

VerifyIdlFilesResponse

Throws:

TencentCloudSDKException