com.tencentcloudapi.batch.v20170312.models

Class Task

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.batch.v20170312.models.Task

public class Task
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
Task()
Task(Task 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
Application	getApplication() Get Application information
Authentication[]	getAuthentications() Get Authorization information
AnonymousComputeEnv	getComputeEnv() Get Compute environment information.
String	getEnvId() Get Compute environment ID.
EnvVar[]	getEnvVars() Get Custom environment variable
String	getFailedAction() Get The processing method after the TaskInstance fails; Value range: `TERMINATE` (default), `INTERRUPT`, `FAST_INTERRUPT`.
InputMapping[]	getInputMappings() Get Input mapping
Long	getMaxConcurrentNum() Get The maximum number of concurrent tasks.
Long	getMaxRetryCount() Get The maximum number of retries after the task fails.
OutputMappingConfig[]	getOutputMappingConfigs() Get Output mapping configuration
OutputMapping[]	getOutputMappings() Get Output mapping
RedirectInfo	getRedirectInfo() Get Redirection information
RedirectLocalInfo	getRedirectLocalInfo() Get Local redirection information
Long	getResourceMaxRetryCount() Get Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process.
Boolean	getRestartComputeNode() Get Restarts the compute node after the task is completed.
Long	getTaskInstanceNum() Get Number of running task instances
String	getTaskName() Get Task name, which should be unique within a job
Long	getTimeout() Get Timeout period of the task in seconds.
void	setApplication(Application Application) Set Application information
void	setAuthentications(Authentication[] Authentications) Set Authorization information
void	setComputeEnv(AnonymousComputeEnv ComputeEnv) Set Compute environment information.
void	setEnvId(String EnvId) Set Compute environment ID.
void	setEnvVars(EnvVar[] EnvVars) Set Custom environment variable
void	setFailedAction(String FailedAction) Set The processing method after the TaskInstance fails; Value range: `TERMINATE` (default), `INTERRUPT`, `FAST_INTERRUPT`.
void	setInputMappings(InputMapping[] InputMappings) Set Input mapping
void	setMaxConcurrentNum(Long MaxConcurrentNum) Set The maximum number of concurrent tasks.
void	setMaxRetryCount(Long MaxRetryCount) Set The maximum number of retries after the task fails.
void	setOutputMappingConfigs(OutputMappingConfig[] OutputMappingConfigs) Set Output mapping configuration
void	setOutputMappings(OutputMapping[] OutputMappings) Set Output mapping
void	setRedirectInfo(RedirectInfo RedirectInfo) Set Redirection information
void	setRedirectLocalInfo(RedirectLocalInfo RedirectLocalInfo) Set Local redirection information
void	setResourceMaxRetryCount(Long ResourceMaxRetryCount) Set Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process.
void	setRestartComputeNode(Boolean RestartComputeNode) Set Restarts the compute node after the task is completed.
void	setTaskInstanceNum(Long TaskInstanceNum) Set Number of running task instances
void	setTaskName(String TaskName) Set Task name, which should be unique within a job
void	setTimeout(Long Timeout) Set Timeout period of the task in seconds.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Task

public Task(Task 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

getApplication

public Application getApplication()

Get Application information

Returns:

Application Application information

setApplication

public void setApplication(Application Application)

Set Application information

Parameters:

Application - Application information

getTaskName

public String getTaskName()

Get Task name, which should be unique within a job

Returns:

TaskName Task name, which should be unique within a job

setTaskName

public void setTaskName(String TaskName)

Set Task name, which should be unique within a job

Parameters:

TaskName - Task name, which should be unique within a job

getTaskInstanceNum

public Long getTaskInstanceNum()

Get Number of running task instances

Returns:

TaskInstanceNum Number of running task instances

setTaskInstanceNum

public void setTaskInstanceNum(Long TaskInstanceNum)

Set Number of running task instances

Parameters:

TaskInstanceNum - Number of running task instances

getComputeEnv

public AnonymousComputeEnv getComputeEnv()

Get Compute environment information. One (and only one) parameter must be specified for ComputeEnv and EnvId.

Returns:

ComputeEnv Compute environment information. One (and only one) parameter must be specified for ComputeEnv and EnvId.

setComputeEnv

public void setComputeEnv(AnonymousComputeEnv ComputeEnv)

Set Compute environment information. One (and only one) parameter must be specified for ComputeEnv and EnvId.

Parameters:

ComputeEnv - Compute environment information. One (and only one) parameter must be specified for ComputeEnv and EnvId.

getEnvId

public String getEnvId()

Get Compute environment ID. One (and only one) parameter must be specified for ComputeEnv and EnvId.

Returns:

EnvId Compute environment ID. One (and only one) parameter must be specified for ComputeEnv and EnvId.

setEnvId

public void setEnvId(String EnvId)

Set Compute environment ID. One (and only one) parameter must be specified for ComputeEnv and EnvId.

Parameters:

EnvId - Compute environment ID. One (and only one) parameter must be specified for ComputeEnv and EnvId.

getRedirectInfo

public RedirectInfo getRedirectInfo()

Get Redirection information

Returns:

RedirectInfo Redirection information

setRedirectInfo

public void setRedirectInfo(RedirectInfo RedirectInfo)

Set Redirection information

Parameters:

RedirectInfo - Redirection information

getRedirectLocalInfo

public RedirectLocalInfo getRedirectLocalInfo()

Get Local redirection information

Returns:

RedirectLocalInfo Local redirection information

setRedirectLocalInfo

public void setRedirectLocalInfo(RedirectLocalInfo RedirectLocalInfo)

Set Local redirection information

Parameters:

RedirectLocalInfo - Local redirection information

getInputMappings

public InputMapping[] getInputMappings()

Get Input mapping

Returns:

InputMappings Input mapping

setInputMappings

public void setInputMappings(InputMapping[] InputMappings)

Set Input mapping

Parameters:

InputMappings - Input mapping

getOutputMappings

public OutputMapping[] getOutputMappings()

Get Output mapping

Returns:

OutputMappings Output mapping

setOutputMappings

public void setOutputMappings(OutputMapping[] OutputMappings)

Set Output mapping

Parameters:

OutputMappings - Output mapping

getOutputMappingConfigs

public OutputMappingConfig[] getOutputMappingConfigs()

Get Output mapping configuration

Returns:

OutputMappingConfigs Output mapping configuration

setOutputMappingConfigs

public void setOutputMappingConfigs(OutputMappingConfig[] OutputMappingConfigs)

Set Output mapping configuration

Parameters:

OutputMappingConfigs - Output mapping configuration

getEnvVars

public EnvVar[] getEnvVars()

Get Custom environment variable

Returns:

EnvVars Custom environment variable

setEnvVars

public void setEnvVars(EnvVar[] EnvVars)

Set Custom environment variable

Parameters:

EnvVars - Custom environment variable

getAuthentications

public Authentication[] getAuthentications()

Get Authorization information

Returns:

Authentications Authorization information

setAuthentications

public void setAuthentications(Authentication[] Authentications)

Set Authorization information

Parameters:

Authentications - Authorization information

getFailedAction

public String getFailedAction()

Get The processing method after the TaskInstance fails; Value range: `TERMINATE` (default), `INTERRUPT`, `FAST_INTERRUPT`.

Returns:

FailedAction The processing method after the TaskInstance fails; Value range: `TERMINATE` (default), `INTERRUPT`, `FAST_INTERRUPT`.

setFailedAction

public void setFailedAction(String FailedAction)

Set The processing method after the TaskInstance fails; Value range: `TERMINATE` (default), `INTERRUPT`, `FAST_INTERRUPT`.

Parameters:

FailedAction - The processing method after the TaskInstance fails; Value range: `TERMINATE` (default), `INTERRUPT`, `FAST_INTERRUPT`.

getMaxRetryCount

public Long getMaxRetryCount()

Get The maximum number of retries after the task fails. Range: 0 - 5. Default value: 0

Returns:

MaxRetryCount The maximum number of retries after the task fails. Range: 0 - 5. Default value: 0

setMaxRetryCount

public void setMaxRetryCount(Long MaxRetryCount)

Set The maximum number of retries after the task fails. Range: 0 - 5. Default value: 0

Parameters:

MaxRetryCount - The maximum number of retries after the task fails. Range: 0 - 5. Default value: 0

getTimeout

public Long getTimeout()

Get Timeout period of the task in seconds. Defaults value: 86400

Returns:

Timeout Timeout period of the task in seconds. Defaults value: 86400

setTimeout

public void setTimeout(Long Timeout)

Set Timeout period of the task in seconds. Defaults value: 86400

Parameters:

Timeout - Timeout period of the task in seconds. Defaults value: 86400

getMaxConcurrentNum

public Long getMaxConcurrentNum()

Get The maximum number of concurrent tasks. Range: 0 - 200000. There is no limit by default.

Returns:

MaxConcurrentNum The maximum number of concurrent tasks. Range: 0 - 200000. There is no limit by default.

setMaxConcurrentNum

public void setMaxConcurrentNum(Long MaxConcurrentNum)

Set The maximum number of concurrent tasks. Range: 0 - 200000. There is no limit by default.

Parameters:

MaxConcurrentNum - The maximum number of concurrent tasks. Range: 0 - 200000. There is no limit by default.

getRestartComputeNode

public Boolean getRestartComputeNode()

Get Restarts the compute node after the task is completed. This is suitable for specifying the compute environment for task execution.

Returns:

RestartComputeNode Restarts the compute node after the task is completed. This is suitable for specifying the compute environment for task execution.

setRestartComputeNode

public void setRestartComputeNode(Boolean RestartComputeNode)

Set Restarts the compute node after the task is completed. This is suitable for specifying the compute environment for task execution.

Parameters:

RestartComputeNode - Restarts the compute node after the task is completed. This is suitable for specifying the compute environment for task execution.

getResourceMaxRetryCount

public Long getResourceMaxRetryCount()

Get Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process. Default: `0`; Maximum: `100`.

Returns:

ResourceMaxRetryCount Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process. Default: `0`; Maximum: `100`.

setResourceMaxRetryCount

public void setResourceMaxRetryCount(Long ResourceMaxRetryCount)

Set Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process. Default: `0`; Maximum: `100`.

Parameters:

ResourceMaxRetryCount - Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process. Default: `0`; Maximum: `100`.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel