com.tencentcloudapi.dlc.v20210125

Class DlcClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.dlc.v20210125.DlcClient

public class DlcClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
DlcClient(Credential credential, String region)
DlcClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CancelSparkSessionBatchSQLResponse	CancelSparkSessionBatchSQL(CancelSparkSessionBatchSQLRequest req) This API is used to cancel a Spark SQL batch task.
CancelTaskResponse	CancelTask(CancelTaskRequest req) This API is used to cancel a task.
CreateDataEngineResponse	CreateDataEngine(CreateDataEngineRequest req) This API is used to create a data engine.
CreateInternalTableResponse	CreateInternalTable(CreateInternalTableRequest req) This API is used to create a managed internal table.
CreateResultDownloadResponse	CreateResultDownload(CreateResultDownloadRequest req) This API is used to create a query result download task.
CreateSparkAppResponse	CreateSparkApp(CreateSparkAppRequest req) This API is used to create a Spark job.
CreateSparkAppTaskResponse	CreateSparkAppTask(CreateSparkAppTaskRequest req) This API is used to start a Spark job.
CreateSparkSessionBatchSQLResponse	CreateSparkSessionBatchSQL(CreateSparkSessionBatchSQLRequest req) This API is used to submit a Spark SQL batch task to the job engine.
CreateTaskResponse	CreateTask(CreateTaskRequest req) This API is used to create and execute a SQL task.
CreateTasksResponse	CreateTasks(CreateTasksRequest req) This API is used to create and execute SQL tasks in batches.
DeleteSparkAppResponse	DeleteSparkApp(DeleteSparkAppRequest req) This API is used to delete a Spark job.
DescribeEngineUsageInfoResponse	DescribeEngineUsageInfo(DescribeEngineUsageInfoRequest req) This API is used to query the resource usage of a data engine based on its ID.
DescribeForbiddenTableProResponse	DescribeForbiddenTablePro(DescribeForbiddenTableProRequest req) This API is used to get the list of disabled table attributes (new).
DescribeLakeFsDirSummaryResponse	DescribeLakeFsDirSummary(DescribeLakeFsDirSummaryRequest req) This API is used to query the summary of a specified directory in a managed storage.
DescribeLakeFsInfoResponse	DescribeLakeFsInfo(DescribeLakeFsInfoRequest req) This API is used to query managed storage information.
DescribeResultDownloadResponse	DescribeResultDownload(DescribeResultDownloadRequest req) This API is used to get a query result download task.
DescribeSparkAppJobResponse	DescribeSparkAppJob(DescribeSparkAppJobRequest req) u200cThis API is used to query the information of a Spark job.
DescribeSparkAppJobsResponse	DescribeSparkAppJobs(DescribeSparkAppJobsRequest req) This API is used to query the list of Spark jobs.
DescribeSparkAppTasksResponse	DescribeSparkAppTasks(DescribeSparkAppTasksRequest req) This API is used to query the list of running task instances of a Spark job.
DescribeSparkSessionBatchSqlLogResponse	DescribeSparkSessionBatchSqlLog(DescribeSparkSessionBatchSqlLogRequest req) This API is used to obtain the logs of a Spark SQL batch task.
DescribeTaskResultResponse	DescribeTaskResult(DescribeTaskResultRequest req) This API is used to query the result of a task.
DescribeTasksResponse	DescribeTasks(DescribeTasksRequest req) This API is used to query the list of tasks.
DescribeUserRolesResponse	DescribeUserRoles(DescribeUserRolesRequest req) This API is used to enumerate user roles.
GenerateCreateMangedTableSqlResponse	GenerateCreateMangedTableSql(GenerateCreateMangedTableSqlRequest req) This API is used to generate SQL statements for creating a managed table.
ModifyGovernEventRuleResponse	ModifyGovernEventRule(ModifyGovernEventRuleRequest req) This API is used to change data governance event thresholds.
ModifySparkAppResponse	ModifySparkApp(ModifySparkAppRequest req) This API is used to update a Spark job.
ModifySparkAppBatchResponse	ModifySparkAppBatch(ModifySparkAppBatchRequest req) This API is used to modify Spark job parameters in batches.
SuspendResumeDataEngineResponse	SuspendResumeDataEngine(SuspendResumeDataEngineRequest req) This API is used to suspend or start a data engine.
SwitchDataEngineResponse	SwitchDataEngine(SwitchDataEngineRequest req) This API is used to switch between the primary and standby clusters.
UpdateRowFilterResponse	UpdateRowFilter(UpdateRowFilterRequest req) This API is used to update row filters.

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

DlcClient

public DlcClient(Credential credential,
                 String region)

DlcClient

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

Method Detail

CancelSparkSessionBatchSQL

public CancelSparkSessionBatchSQLResponse CancelSparkSessionBatchSQL(CancelSparkSessionBatchSQLRequest req)
                                                              throws TencentCloudSDKException

This API is used to cancel a Spark SQL batch task.

Parameters:

req - CancelSparkSessionBatchSQLRequest

Returns:

CancelSparkSessionBatchSQLResponse

Throws:

TencentCloudSDKException

CancelTask

public CancelTaskResponse CancelTask(CancelTaskRequest req)
                              throws TencentCloudSDKException

This API is used to cancel a task.

Parameters:

req - CancelTaskRequest

Returns:

CancelTaskResponse

Throws:

TencentCloudSDKException

CreateDataEngine

public CreateDataEngineResponse CreateDataEngine(CreateDataEngineRequest req)
                                          throws TencentCloudSDKException

This API is used to create a data engine.

Parameters:

req - CreateDataEngineRequest

Returns:

CreateDataEngineResponse

Throws:

TencentCloudSDKException

CreateInternalTable

public CreateInternalTableResponse CreateInternalTable(CreateInternalTableRequest req)
                                                throws TencentCloudSDKException

This API is used to create a managed internal table. It has been disused.

Parameters:

req - CreateInternalTableRequest

Returns:

CreateInternalTableResponse

Throws:

TencentCloudSDKException

CreateResultDownload

public CreateResultDownloadResponse CreateResultDownload(CreateResultDownloadRequest req)
                                                  throws TencentCloudSDKException

This API is used to create a query result download task.

Parameters:

req - CreateResultDownloadRequest

Returns:

CreateResultDownloadResponse

Throws:

TencentCloudSDKException

CreateSparkApp

public CreateSparkAppResponse CreateSparkApp(CreateSparkAppRequest req)
                                      throws TencentCloudSDKException

This API is used to create a Spark job.

Parameters:

req - CreateSparkAppRequest

Returns:

CreateSparkAppResponse

Throws:

TencentCloudSDKException

CreateSparkAppTask

public CreateSparkAppTaskResponse CreateSparkAppTask(CreateSparkAppTaskRequest req)
                                              throws TencentCloudSDKException

This API is used to start a Spark job.

Parameters:

req - CreateSparkAppTaskRequest

Returns:

CreateSparkAppTaskResponse

Throws:

TencentCloudSDKException

CreateSparkSessionBatchSQL

public CreateSparkSessionBatchSQLResponse CreateSparkSessionBatchSQL(CreateSparkSessionBatchSQLRequest req)
                                                              throws TencentCloudSDKException

This API is used to submit a Spark SQL batch task to the job engine.

Parameters:

req - CreateSparkSessionBatchSQLRequest

Returns:

CreateSparkSessionBatchSQLResponse

Throws:

TencentCloudSDKException

CreateTask

public CreateTaskResponse CreateTask(CreateTaskRequest req)
                              throws TencentCloudSDKException

This API is used to create and execute a SQL task. (`CreateTasks` is recommended.)

Parameters:

req - CreateTaskRequest

Returns:

CreateTaskResponse

Throws:

TencentCloudSDKException

CreateTasks

public CreateTasksResponse CreateTasks(CreateTasksRequest req)
                                throws TencentCloudSDKException

This API is used to create and execute SQL tasks in batches.

Parameters:

req - CreateTasksRequest

Returns:

CreateTasksResponse

Throws:

TencentCloudSDKException

DeleteSparkApp

public DeleteSparkAppResponse DeleteSparkApp(DeleteSparkAppRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a Spark job.

Parameters:

req - DeleteSparkAppRequest

Returns:

DeleteSparkAppResponse

Throws:

TencentCloudSDKException

DescribeEngineUsageInfo

public DescribeEngineUsageInfoResponse DescribeEngineUsageInfo(DescribeEngineUsageInfoRequest req)
                                                        throws TencentCloudSDKException

This API is used to query the resource usage of a data engine based on its ID.

Parameters:

req - DescribeEngineUsageInfoRequest

Returns:

DescribeEngineUsageInfoResponse

Throws:

TencentCloudSDKException

DescribeForbiddenTablePro

public DescribeForbiddenTableProResponse DescribeForbiddenTablePro(DescribeForbiddenTableProRequest req)
                                                            throws TencentCloudSDKException

This API is used to get the list of disabled table attributes (new).

Parameters:

req - DescribeForbiddenTableProRequest

Returns:

DescribeForbiddenTableProResponse

Throws:

TencentCloudSDKException

DescribeLakeFsDirSummary

public DescribeLakeFsDirSummaryResponse DescribeLakeFsDirSummary(DescribeLakeFsDirSummaryRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the summary of a specified directory in a managed storage.

Parameters:

req - DescribeLakeFsDirSummaryRequest

Returns:

DescribeLakeFsDirSummaryResponse

Throws:

TencentCloudSDKException

DescribeLakeFsInfo

public DescribeLakeFsInfoResponse DescribeLakeFsInfo(DescribeLakeFsInfoRequest req)
                                              throws TencentCloudSDKException

This API is used to query managed storage information.

Parameters:

req - DescribeLakeFsInfoRequest

Returns:

DescribeLakeFsInfoResponse

Throws:

TencentCloudSDKException

DescribeResultDownload

public DescribeResultDownloadResponse DescribeResultDownload(DescribeResultDownloadRequest req)
                                                      throws TencentCloudSDKException

This API is used to get a query result download task.

Parameters:

req - DescribeResultDownloadRequest

Returns:

DescribeResultDownloadResponse

Throws:

TencentCloudSDKException

DescribeSparkAppJob

public DescribeSparkAppJobResponse DescribeSparkAppJob(DescribeSparkAppJobRequest req)
                                                throws TencentCloudSDKException

u200cThis API is used to query the information of a Spark job.

Parameters:

req - DescribeSparkAppJobRequest

Returns:

DescribeSparkAppJobResponse

Throws:

TencentCloudSDKException

DescribeSparkAppJobs

public DescribeSparkAppJobsResponse DescribeSparkAppJobs(DescribeSparkAppJobsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the list of Spark jobs.

Parameters:

req - DescribeSparkAppJobsRequest

Returns:

DescribeSparkAppJobsResponse

Throws:

TencentCloudSDKException

DescribeSparkAppTasks

public DescribeSparkAppTasksResponse DescribeSparkAppTasks(DescribeSparkAppTasksRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the list of running task instances of a Spark job.

Parameters:

req - DescribeSparkAppTasksRequest

Returns:

DescribeSparkAppTasksResponse

Throws:

TencentCloudSDKException

DescribeSparkSessionBatchSqlLog

public DescribeSparkSessionBatchSqlLogResponse DescribeSparkSessionBatchSqlLog(DescribeSparkSessionBatchSqlLogRequest req)
                                                                        throws TencentCloudSDKException

This API is used to obtain the logs of a Spark SQL batch task.

Parameters:

req - DescribeSparkSessionBatchSqlLogRequest

Returns:

DescribeSparkSessionBatchSqlLogResponse

Throws:

TencentCloudSDKException

DescribeTaskResult

public DescribeTaskResultResponse DescribeTaskResult(DescribeTaskResultRequest req)
                                              throws TencentCloudSDKException

This API is used to query the result of a task.

Parameters:

req - DescribeTaskResultRequest

Returns:

DescribeTaskResultResponse

Throws:

TencentCloudSDKException

DescribeTasks

public DescribeTasksResponse DescribeTasks(DescribeTasksRequest req)
                                    throws TencentCloudSDKException

This API is used to query the list of tasks.

Parameters:

req - DescribeTasksRequest

Returns:

DescribeTasksResponse

Throws:

TencentCloudSDKException

DescribeUserRoles

public DescribeUserRolesResponse DescribeUserRoles(DescribeUserRolesRequest req)
                                            throws TencentCloudSDKException

This API is used to enumerate user roles.

Parameters:

req - DescribeUserRolesRequest

Returns:

DescribeUserRolesResponse

Throws:

TencentCloudSDKException

GenerateCreateMangedTableSql

public GenerateCreateMangedTableSqlResponse GenerateCreateMangedTableSql(GenerateCreateMangedTableSqlRequest req)
                                                                  throws TencentCloudSDKException

This API is used to generate SQL statements for creating a managed table.

Parameters:

req - GenerateCreateMangedTableSqlRequest

Returns:

GenerateCreateMangedTableSqlResponse

Throws:

TencentCloudSDKException

ModifyGovernEventRule

public ModifyGovernEventRuleResponse ModifyGovernEventRule(ModifyGovernEventRuleRequest req)
                                                    throws TencentCloudSDKException

This API is used to change data governance event thresholds.

Parameters:

req - ModifyGovernEventRuleRequest

Returns:

ModifyGovernEventRuleResponse

Throws:

TencentCloudSDKException

ModifySparkApp

public ModifySparkAppResponse ModifySparkApp(ModifySparkAppRequest req)
                                      throws TencentCloudSDKException

This API is used to update a Spark job.

Parameters:

req - ModifySparkAppRequest

Returns:

ModifySparkAppResponse

Throws:

TencentCloudSDKException

ModifySparkAppBatch

public ModifySparkAppBatchResponse ModifySparkAppBatch(ModifySparkAppBatchRequest req)
                                                throws TencentCloudSDKException

This API is used to modify Spark job parameters in batches.

Parameters:

req - ModifySparkAppBatchRequest

Returns:

ModifySparkAppBatchResponse

Throws:

TencentCloudSDKException

SuspendResumeDataEngine

public SuspendResumeDataEngineResponse SuspendResumeDataEngine(SuspendResumeDataEngineRequest req)
                                                        throws TencentCloudSDKException

This API is used to suspend or start a data engine.

Parameters:

req - SuspendResumeDataEngineRequest

Returns:

SuspendResumeDataEngineResponse

Throws:

TencentCloudSDKException

SwitchDataEngine

public SwitchDataEngineResponse SwitchDataEngine(SwitchDataEngineRequest req)
                                          throws TencentCloudSDKException

This API is used to switch between the primary and standby clusters.

Parameters:

req - SwitchDataEngineRequest

Returns:

SwitchDataEngineResponse

Throws:

TencentCloudSDKException

UpdateRowFilter

public UpdateRowFilterResponse UpdateRowFilter(UpdateRowFilterRequest req)
                                        throws TencentCloudSDKException

This API is used to update row filters. Please note that it updates filters only but not catalogs, databases, or tables.

Parameters:

req - UpdateRowFilterRequest

Returns:

UpdateRowFilterResponse

Throws:

TencentCloudSDKException