com.tencentcloudapi.dlc.v20210125.models

Class TaskResultInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.dlc.v20210125.models.TaskResultInfo

public class TaskResultInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
TaskResultInfo()
TaskResultInfo(TaskResultInfo source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getCreateTime() Get Task creation timestamp
Long	getDataAmount() Get Amount of the data scanned in bytes
String	getDatabaseName() Get Name of the default selected database when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.
String	getDatasourceConnectionName() Get Name of the default selected data source when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.
String	getDisplayFormat() Get Console display format.
String	getNextToken() Get Pagination information.
String	getOutputMessage() Get Task execution information.
String	getOutputPath() Get Address of the COS bucket for storing the task result
Long	getPercentage() Get Task progress (%)
String	getProgressDetail() Get Task progress details
Float	getQueryResultTime() Get Time consumed to get results Note: This field may return null, indicating that no valid values can be obtained.
Column[]	getResultSchema() Get Schema information of the result Note: This field may return null, indicating that no valid values can be obtained.
String	getResultSet() Get Result information.
String	getRowAffectInfo() Get Number of affected rows
String	getSQL() Get The currently executed SQL statement.
String	getSQLType() Get Type of the executed task.
Long	getState() Get u200cThe current task status.
String	getTaskId() Get Unique task ID
Long	getTotalTime() Get The task time in ms.
Long	getUsedTime() Get The compute time in ms.
void	setCreateTime(String CreateTime) Set Task creation timestamp
void	setDataAmount(Long DataAmount) Set Amount of the data scanned in bytes
void	setDatabaseName(String DatabaseName) Set Name of the default selected database when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.
void	setDatasourceConnectionName(String DatasourceConnectionName) Set Name of the default selected data source when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.
void	setDisplayFormat(String DisplayFormat) Set Console display format.
void	setNextToken(String NextToken) Set Pagination information.
void	setOutputMessage(String OutputMessage) Set Task execution information.
void	setOutputPath(String OutputPath) Set Address of the COS bucket for storing the task result
void	setPercentage(Long Percentage) Set Task progress (%)
void	setProgressDetail(String ProgressDetail) Set Task progress details
void	setQueryResultTime(Float QueryResultTime) Set Time consumed to get results Note: This field may return null, indicating that no valid values can be obtained.
void	setResultSchema(Column[] ResultSchema) Set Schema information of the result Note: This field may return null, indicating that no valid values can be obtained.
void	setResultSet(String ResultSet) Set Result information.
void	setRowAffectInfo(String RowAffectInfo) Set Number of affected rows
void	setSQL(String SQL) Set The currently executed SQL statement.
void	setSQLType(String SQLType) Set Type of the executed task.
void	setState(Long State) Set u200cThe current task status.
void	setTaskId(String TaskId) Set Unique task ID
void	setTotalTime(Long TotalTime) Set The task time in ms.
void	setUsedTime(Long UsedTime) Set The compute time in ms.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskResultInfo

public TaskResultInfo()

TaskResultInfo

public TaskResultInfo(TaskResultInfo source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getTaskId

public String getTaskId()

Get Unique task ID

Returns:

TaskId Unique task ID

setTaskId

public void setTaskId(String TaskId)

Set Unique task ID

Parameters:

TaskId - Unique task ID

getDatasourceConnectionName

public String getDatasourceConnectionName()

Get Name of the default selected data source when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DatasourceConnectionName Name of the default selected data source when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

setDatasourceConnectionName

public void setDatasourceConnectionName(String DatasourceConnectionName)

Set Name of the default selected data source when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DatasourceConnectionName - Name of the default selected data source when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

getDatabaseName

public String getDatabaseName()

Get Name of the default selected database when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DatabaseName Name of the default selected database when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

setDatabaseName

public void setDatabaseName(String DatabaseName)

Set Name of the default selected database when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DatabaseName - Name of the default selected database when the current job is executed Note: This field may return null, indicating that no valid values can be obtained.

getSQL

public String getSQL()

Get The currently executed SQL statement. Each task contains one SQL statement.

Returns:

SQL The currently executed SQL statement. Each task contains one SQL statement.

setSQL

public void setSQL(String SQL)

Set The currently executed SQL statement. Each task contains one SQL statement.

Parameters:

SQL - The currently executed SQL statement. Each task contains one SQL statement.

getSQLType

public String getSQLType()

Get Type of the executed task. Valid values: `DDL`, `DML`, `DQL`.

Returns:

SQLType Type of the executed task. Valid values: `DDL`, `DML`, `DQL`.

setSQLType

public void setSQLType(String SQLType)

Set Type of the executed task. Valid values: `DDL`, `DML`, `DQL`.

Parameters:

SQLType - Type of the executed task. Valid values: `DDL`, `DML`, `DQL`.

getState

public Long getState()

Get u200cThe current task status. Valid values: `0` (initializing), `1` (executing), `2` (executed), `3` (writing data), `4` (queuing), u200c`-1` (failed), and `-3` (canceled). Only when the task is successfully executed, a task execution result will be returned.

Returns:

State u200cThe current task status. Valid values: `0` (initializing), `1` (executing), `2` (executed), `3` (writing data), `4` (queuing), u200c`-1` (failed), and `-3` (canceled). Only when the task is successfully executed, a task execution result will be returned.

setState

public void setState(Long State)

Set u200cThe current task status. Valid values: `0` (initializing), `1` (executing), `2` (executed), `3` (writing data), `4` (queuing), u200c`-1` (failed), and `-3` (canceled). Only when the task is successfully executed, a task execution result will be returned.

Parameters:

State - u200cThe current task status. Valid values: `0` (initializing), `1` (executing), `2` (executed), `3` (writing data), `4` (queuing), u200c`-1` (failed), and `-3` (canceled). Only when the task is successfully executed, a task execution result will be returned.

getDataAmount

public Long getDataAmount()

Get Amount of the data scanned in bytes

Returns:

DataAmount Amount of the data scanned in bytes

setDataAmount

public void setDataAmount(Long DataAmount)

Set Amount of the data scanned in bytes

Parameters:

DataAmount - Amount of the data scanned in bytes

getUsedTime

public Long getUsedTime()

Get The compute time in ms.

Returns:

UsedTime The compute time in ms.

setUsedTime

public void setUsedTime(Long UsedTime)

Set The compute time in ms.

Parameters:

UsedTime - The compute time in ms.

getOutputPath

public String getOutputPath()

Get Address of the COS bucket for storing the task result

Returns:

OutputPath Address of the COS bucket for storing the task result

setOutputPath

public void setOutputPath(String OutputPath)

Set Address of the COS bucket for storing the task result

Parameters:

OutputPath - Address of the COS bucket for storing the task result

getCreateTime

public String getCreateTime()

Get Task creation timestamp

Returns:

CreateTime Task creation timestamp

setCreateTime

public void setCreateTime(String CreateTime)

Set Task creation timestamp

Parameters:

CreateTime - Task creation timestamp

getOutputMessage

public String getOutputMessage()

Get Task execution information. `success` will be returned if the task succeeds; otherwise, the failure cause will be returned.

Returns:

OutputMessage Task execution information. `success` will be returned if the task succeeds; otherwise, the failure cause will be returned.

setOutputMessage

public void setOutputMessage(String OutputMessage)

Set Task execution information. `success` will be returned if the task succeeds; otherwise, the failure cause will be returned.

Parameters:

OutputMessage - Task execution information. `success` will be returned if the task succeeds; otherwise, the failure cause will be returned.

getRowAffectInfo

public String getRowAffectInfo()

Get Number of affected rows

Returns:

RowAffectInfo Number of affected rows

setRowAffectInfo

public void setRowAffectInfo(String RowAffectInfo)

Set Number of affected rows

Parameters:

RowAffectInfo - Number of affected rows

getResultSchema

public Column[] getResultSchema()

Get Schema information of the result Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ResultSchema Schema information of the result Note: This field may return null, indicating that no valid values can be obtained.

setResultSchema

public void setResultSchema(Column[] ResultSchema)

Set Schema information of the result Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ResultSchema - Schema information of the result Note: This field may return null, indicating that no valid values can be obtained.

getResultSet

public String getResultSet()

Get Result information. After it is unescaped, each element of the outer array is a data row. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ResultSet Result information. After it is unescaped, each element of the outer array is a data row. Note: This field may return null, indicating that no valid values can be obtained.

setResultSet

public void setResultSet(String ResultSet)

Set Result information. After it is unescaped, each element of the outer array is a data row. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ResultSet - Result information. After it is unescaped, each element of the outer array is a data row. Note: This field may return null, indicating that no valid values can be obtained.

getNextToken

public String getNextToken()

Get Pagination information. If there is no more result data, `nextToken` will be empty.

Returns:

NextToken Pagination information. If there is no more result data, `nextToken` will be empty.

setNextToken

public void setNextToken(String NextToken)

Set Pagination information. If there is no more result data, `nextToken` will be empty.

Parameters:

NextToken - Pagination information. If there is no more result data, `nextToken` will be empty.

getPercentage

public Long getPercentage()

Get Task progress (%)

Returns:

Percentage Task progress (%)

setPercentage

public void setPercentage(Long Percentage)

Set Task progress (%)

Parameters:

Percentage - Task progress (%)

getProgressDetail

public String getProgressDetail()

Get Task progress details

Returns:

ProgressDetail Task progress details

setProgressDetail

public void setProgressDetail(String ProgressDetail)

Set Task progress details

Parameters:

ProgressDetail - Task progress details

getDisplayFormat

public String getDisplayFormat()

Get Console display format. Valid values: `table`, `text`.

Returns:

DisplayFormat Console display format. Valid values: `table`, `text`.

setDisplayFormat

public void setDisplayFormat(String DisplayFormat)

Set Console display format. Valid values: `table`, `text`.

Parameters:

DisplayFormat - Console display format. Valid values: `table`, `text`.

getTotalTime

public Long getTotalTime()

Get The task time in ms.

Returns:

TotalTime The task time in ms.

setTotalTime

public void setTotalTime(Long TotalTime)

Set The task time in ms.

Parameters:

TotalTime - The task time in ms.

getQueryResultTime

public Float getQueryResultTime()

Get Time consumed to get results Note: This field may return null, indicating that no valid values can be obtained.

Returns:

QueryResultTime Time consumed to get results Note: This field may return null, indicating that no valid values can be obtained.

setQueryResultTime

public void setQueryResultTime(Float QueryResultTime)

Set Time consumed to get results Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

QueryResultTime - Time consumed to get results Note: This field may return null, indicating that no valid values can be obtained.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.