CreateTrainingTaskRequest (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.tione.v20211111.models.CreateTrainingTaskRequest

public class CreateTrainingTaskRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`CreateTrainingTaskRequest()`
`CreateTrainingTaskRequest(CreateTrainingTaskRequest 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCallbackUrl()` Get 回调地址，用于创建/启动/停止训练任务的异步回调。回调格式&内容详见：[[TI-ONE接口回调说明]](https://cloud.tencent.com/document/product/851/84292)
`String`	`getChargeType()` Get 计费模式，eg：PREPAID 包年包月（资源组）; POSTPAID_BY_HOUR 按量计费
`CosPathInfo`	`getCodePackagePath()` Get COS代码包路径
`CodeRepoConfig[]`	`getCodeRepos()` Get 代码仓库配置
`DataConfig[]`	`getDataConfigs()` Get 数据配置，依赖DataSource字段，数量不超过10个
`String`	`getDataSource()` Get 数据来源，eg：DATASET、COS、CFS、CFSTurbo、HDFS、GooseFSx
`EncodedStartCmdInfo`	`getEncodedStartCmdInfo()` Get 编码后的任务启动命令，与StartCmdInfo同时配置时，仅当前参数生效
`String`	`getFrameworkEnvironment()` Get 训练框架环境，通过DescribeTrainingFrameworks接口查询，eg：tf1.15-py3.7-cpu、torch1.9-py3.8-cuda11.1-gpu
`String`	`getFrameworkName()` Get 训练框架名称，通过DescribeTrainingFrameworks接口查询，eg：SPARK、PYSPARK、TENSORFLOW、PYTORCH
`String`	`getFrameworkVersion()` Get 训练框架版本，通过DescribeTrainingFrameworks接口查询，eg：1.15、1.9
`ImageInfo`	`getImageInfo()` Get 自定义镜像信息
`LogConfig`	`getLogConfig()` Get CLS日志配置
`Boolean`	`getLogEnable()` Get 是否上报日志
`String`	`getName()` Get 训练任务名称，不超过60个字符，仅支持中英文、数字、下划线"_"、短横"-"，只能以中英文、数字开头
`CosPathInfo`	`getOutput()` Get COS训练输出路径
`String`	`getRemark()` Get 备注，不超过1024个字符
`ResourceConfigInfo[]`	`getResourceConfigInfos()` Get 资源配置，需填写对应算力规格ID和节点数量，算力规格ID查询接口为DescribeBillingSpecsPrice，eg：[{"Role":"WORKER", "InstanceType": "TI.S.MEDIUM.POST", "InstanceNum": 1}]
`String`	`getResourceGroupId()` Get 预付费专用资源组ID，通过DescribeBillingResourceGroups接口查询
`StartCmdInfo`	`getStartCmdInfo()` Get 任务的启动命令，按任务训练模式输入，如遇特殊字符导致配置失败，可使用EncodedStartCmdInfo参数
`String`	`getSubnetId()` Get 子网Id
`Tag[]`	`getTags()` Get 标签配置
`String`	`getTrainingMode()` Get 训练模式，通过DescribeTrainingFrameworks接口查询，eg：PS_WORKER、DDP、MPI、HOROVOD
`String`	`getTuningParameters()` Get 调优参数，不超过2048个字符
`String`	`getVpcId()` Get VPC Id
`void`	`setCallbackUrl(String CallbackUrl)` Set 回调地址，用于创建/启动/停止训练任务的异步回调。回调格式&内容详见：[[TI-ONE接口回调说明]](https://cloud.tencent.com/document/product/851/84292)
`void`	`setChargeType(String ChargeType)` Set 计费模式，eg：PREPAID 包年包月（资源组）; POSTPAID_BY_HOUR 按量计费
`void`	`setCodePackagePath(CosPathInfo CodePackagePath)` Set COS代码包路径
`void`	`setCodeRepos(CodeRepoConfig[] CodeRepos)` Set 代码仓库配置
`void`	`setDataConfigs(DataConfig[] DataConfigs)` Set 数据配置，依赖DataSource字段，数量不超过10个
`void`	`setDataSource(String DataSource)` Set 数据来源，eg：DATASET、COS、CFS、CFSTurbo、HDFS、GooseFSx
`void`	`setEncodedStartCmdInfo(EncodedStartCmdInfo EncodedStartCmdInfo)` Set 编码后的任务启动命令，与StartCmdInfo同时配置时，仅当前参数生效
`void`	`setFrameworkEnvironment(String FrameworkEnvironment)` Set 训练框架环境，通过DescribeTrainingFrameworks接口查询，eg：tf1.15-py3.7-cpu、torch1.9-py3.8-cuda11.1-gpu
`void`	`setFrameworkName(String FrameworkName)` Set 训练框架名称，通过DescribeTrainingFrameworks接口查询，eg：SPARK、PYSPARK、TENSORFLOW、PYTORCH
`void`	`setFrameworkVersion(String FrameworkVersion)` Set 训练框架版本，通过DescribeTrainingFrameworks接口查询，eg：1.15、1.9
`void`	`setImageInfo(ImageInfo ImageInfo)` Set 自定义镜像信息
`void`	`setLogConfig(LogConfig LogConfig)` Set CLS日志配置
`void`	`setLogEnable(Boolean LogEnable)` Set 是否上报日志
`void`	`setName(String Name)` Set 训练任务名称，不超过60个字符，仅支持中英文、数字、下划线"_"、短横"-"，只能以中英文、数字开头
`void`	`setOutput(CosPathInfo Output)` Set COS训练输出路径
`void`	`setRemark(String Remark)` Set 备注，不超过1024个字符
`void`	`setResourceConfigInfos(ResourceConfigInfo[] ResourceConfigInfos)` Set 资源配置，需填写对应算力规格ID和节点数量，算力规格ID查询接口为DescribeBillingSpecsPrice，eg：[{"Role":"WORKER", "InstanceType": "TI.S.MEDIUM.POST", "InstanceNum": 1}]
`void`	`setResourceGroupId(String ResourceGroupId)` Set 预付费专用资源组ID，通过DescribeBillingResourceGroups接口查询
`void`	`setStartCmdInfo(StartCmdInfo StartCmdInfo)` Set 任务的启动命令，按任务训练模式输入，如遇特殊字符导致配置失败，可使用EncodedStartCmdInfo参数
`void`	`setSubnetId(String SubnetId)` Set 子网Id
`void`	`setTags(Tag[] Tags)` Set 标签配置
`void`	`setTrainingMode(String TrainingMode)` Set 训练模式，通过DescribeTrainingFrameworks接口查询，eg：PS_WORKER、DDP、MPI、HOROVOD
`void`	`setTuningParameters(String TuningParameters)` Set 调优参数，不超过2048个字符
`void`	`setVpcId(String VpcId)` Set VPC Id
`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
  - CreateTrainingTaskRequest
```
public CreateTrainingTaskRequest()
```
  - CreateTrainingTaskRequest
```
public CreateTrainingTaskRequest(CreateTrainingTaskRequest 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
  - getName
```
public String getName()
```
    Get 训练任务名称，不超过60个字符，仅支持中英文、数字、下划线"_"、短横"-"，只能以中英文、数字开头
    
    Returns:
    
    Name 训练任务名称，不超过60个字符，仅支持中英文、数字、下划线"_"、短横"-"，只能以中英文、数字开头
  - setName
```
public void setName(String Name)
```
    Set 训练任务名称，不超过60个字符，仅支持中英文、数字、下划线"_"、短横"-"，只能以中英文、数字开头
    
    Parameters:
    
    Name - 训练任务名称，不超过60个字符，仅支持中英文、数字、下划线"_"、短横"-"，只能以中英文、数字开头
  - getChargeType
```
public String getChargeType()
```
    Get 计费模式，eg：PREPAID 包年包月（资源组）; POSTPAID_BY_HOUR 按量计费
    
    Returns:
    
    ChargeType 计费模式，eg：PREPAID 包年包月（资源组）; POSTPAID_BY_HOUR 按量计费
  - setChargeType
```
public void setChargeType(String ChargeType)
```
    Set 计费模式，eg：PREPAID 包年包月（资源组）; POSTPAID_BY_HOUR 按量计费
    
    Parameters:
    
    ChargeType - 计费模式，eg：PREPAID 包年包月（资源组）; POSTPAID_BY_HOUR 按量计费
  - getResourceConfigInfos
```
public ResourceConfigInfo[] getResourceConfigInfos()
```
    Get 资源配置，需填写对应算力规格ID和节点数量，算力规格ID查询接口为DescribeBillingSpecsPrice，eg：[{"Role":"WORKER", "InstanceType": "TI.S.MEDIUM.POST", "InstanceNum": 1}]
    
    Returns:
    
    ResourceConfigInfos 资源配置，需填写对应算力规格ID和节点数量，算力规格ID查询接口为DescribeBillingSpecsPrice，eg：[{"Role":"WORKER", "InstanceType": "TI.S.MEDIUM.POST", "InstanceNum": 1}]
  - setResourceConfigInfos
```
public void setResourceConfigInfos(ResourceConfigInfo[] ResourceConfigInfos)
```
    Set 资源配置，需填写对应算力规格ID和节点数量，算力规格ID查询接口为DescribeBillingSpecsPrice，eg：[{"Role":"WORKER", "InstanceType": "TI.S.MEDIUM.POST", "InstanceNum": 1}]
    
    Parameters:
    
    ResourceConfigInfos - 资源配置，需填写对应算力规格ID和节点数量，算力规格ID查询接口为DescribeBillingSpecsPrice，eg：[{"Role":"WORKER", "InstanceType": "TI.S.MEDIUM.POST", "InstanceNum": 1}]
  - getFrameworkName
```
public String getFrameworkName()
```
    Get 训练框架名称，通过DescribeTrainingFrameworks接口查询，eg：SPARK、PYSPARK、TENSORFLOW、PYTORCH
    
    Returns:
    
    FrameworkName 训练框架名称，通过DescribeTrainingFrameworks接口查询，eg：SPARK、PYSPARK、TENSORFLOW、PYTORCH
  - setFrameworkName
```
public void setFrameworkName(String FrameworkName)
```
    Set 训练框架名称，通过DescribeTrainingFrameworks接口查询，eg：SPARK、PYSPARK、TENSORFLOW、PYTORCH
    
    Parameters:
    
    FrameworkName - 训练框架名称，通过DescribeTrainingFrameworks接口查询，eg：SPARK、PYSPARK、TENSORFLOW、PYTORCH
  - getFrameworkVersion
```
public String getFrameworkVersion()
```
    Get 训练框架版本，通过DescribeTrainingFrameworks接口查询，eg：1.15、1.9
    
    Returns:
    
    FrameworkVersion 训练框架版本，通过DescribeTrainingFrameworks接口查询，eg：1.15、1.9
  - setFrameworkVersion
```
public void setFrameworkVersion(String FrameworkVersion)
```
    Set 训练框架版本，通过DescribeTrainingFrameworks接口查询，eg：1.15、1.9
    
    Parameters:
    
    FrameworkVersion - 训练框架版本，通过DescribeTrainingFrameworks接口查询，eg：1.15、1.9
  - getFrameworkEnvironment
```
public String getFrameworkEnvironment()
```
    Get 训练框架环境，通过DescribeTrainingFrameworks接口查询，eg：tf1.15-py3.7-cpu、torch1.9-py3.8-cuda11.1-gpu
    
    Returns:
    
    FrameworkEnvironment 训练框架环境，通过DescribeTrainingFrameworks接口查询，eg：tf1.15-py3.7-cpu、torch1.9-py3.8-cuda11.1-gpu
  - setFrameworkEnvironment
```
public void setFrameworkEnvironment(String FrameworkEnvironment)
```
    Set 训练框架环境，通过DescribeTrainingFrameworks接口查询，eg：tf1.15-py3.7-cpu、torch1.9-py3.8-cuda11.1-gpu
    
    Parameters:
    
    FrameworkEnvironment - 训练框架环境，通过DescribeTrainingFrameworks接口查询，eg：tf1.15-py3.7-cpu、torch1.9-py3.8-cuda11.1-gpu
  - getResourceGroupId
```
public String getResourceGroupId()
```
    Get 预付费专用资源组ID，通过DescribeBillingResourceGroups接口查询
    
    Returns:
    
    ResourceGroupId 预付费专用资源组ID，通过DescribeBillingResourceGroups接口查询
  - setResourceGroupId
```
public void setResourceGroupId(String ResourceGroupId)
```
    Set 预付费专用资源组ID，通过DescribeBillingResourceGroups接口查询
    
    Parameters:
    
    ResourceGroupId - 预付费专用资源组ID，通过DescribeBillingResourceGroups接口查询
  - getTags
```
public Tag[] getTags()
```
    Get 标签配置
    
    Returns:
    
    Tags 标签配置
  - setTags
```
public void setTags(Tag[] Tags)
```
    Set 标签配置
    
    Parameters:
    
    Tags - 标签配置
  - getImageInfo
```
public ImageInfo getImageInfo()
```
    Get 自定义镜像信息
    
    Returns:
    
    ImageInfo 自定义镜像信息
  - setImageInfo
```
public void setImageInfo(ImageInfo ImageInfo)
```
    Set 自定义镜像信息
    
    Parameters:
    
    ImageInfo - 自定义镜像信息
  - getCodePackagePath
```
public CosPathInfo getCodePackagePath()
```
    Get COS代码包路径
    
    Returns:
    
    CodePackagePath COS代码包路径
  - setCodePackagePath
```
public void setCodePackagePath(CosPathInfo CodePackagePath)
```
    Set COS代码包路径
    
    Parameters:
    
    CodePackagePath - COS代码包路径
  - getStartCmdInfo
```
public StartCmdInfo getStartCmdInfo()
```
    Get 任务的启动命令，按任务训练模式输入，如遇特殊字符导致配置失败，可使用EncodedStartCmdInfo参数
    
    Returns:
    
    StartCmdInfo 任务的启动命令，按任务训练模式输入，如遇特殊字符导致配置失败，可使用EncodedStartCmdInfo参数
  - setStartCmdInfo
```
public void setStartCmdInfo(StartCmdInfo StartCmdInfo)
```
    Set 任务的启动命令，按任务训练模式输入，如遇特殊字符导致配置失败，可使用EncodedStartCmdInfo参数
    
    Parameters:
    
    StartCmdInfo - 任务的启动命令，按任务训练模式输入，如遇特殊字符导致配置失败，可使用EncodedStartCmdInfo参数
  - getTrainingMode
```
public String getTrainingMode()
```
    Get 训练模式，通过DescribeTrainingFrameworks接口查询，eg：PS_WORKER、DDP、MPI、HOROVOD
    
    Returns:
    
    TrainingMode 训练模式，通过DescribeTrainingFrameworks接口查询，eg：PS_WORKER、DDP、MPI、HOROVOD
  - setTrainingMode
```
public void setTrainingMode(String TrainingMode)
```
    Set 训练模式，通过DescribeTrainingFrameworks接口查询，eg：PS_WORKER、DDP、MPI、HOROVOD
    
    Parameters:
    
    TrainingMode - 训练模式，通过DescribeTrainingFrameworks接口查询，eg：PS_WORKER、DDP、MPI、HOROVOD
  - getDataConfigs
```
public DataConfig[] getDataConfigs()
```
    Get 数据配置，依赖DataSource字段，数量不超过10个
    
    Returns:
    
    DataConfigs 数据配置，依赖DataSource字段，数量不超过10个
  - setDataConfigs
```
public void setDataConfigs(DataConfig[] DataConfigs)
```
    Set 数据配置，依赖DataSource字段，数量不超过10个
    
    Parameters:
    
    DataConfigs - 数据配置，依赖DataSource字段，数量不超过10个
  - getVpcId
```
public String getVpcId()
```
    Get VPC Id
    
    Returns:
    
    VpcId VPC Id
  - setVpcId
```
public void setVpcId(String VpcId)
```
    Set VPC Id
    
    Parameters:
    
    VpcId - VPC Id
  - getSubnetId
```
public String getSubnetId()
```
    Get 子网Id
    
    Returns:
    
    SubnetId 子网Id
  - setSubnetId
```
public void setSubnetId(String SubnetId)
```
    Set 子网Id
    
    Parameters:
    
    SubnetId - 子网Id
  - getOutput
```
public CosPathInfo getOutput()
```
    Get COS训练输出路径
    
    Returns:
    
    Output COS训练输出路径
  - setOutput
```
public void setOutput(CosPathInfo Output)
```
    Set COS训练输出路径
    
    Parameters:
    
    Output - COS训练输出路径
  - getLogConfig
```
public LogConfig getLogConfig()
```
    Get CLS日志配置
    
    Returns:
    
    LogConfig CLS日志配置
  - setLogConfig
```
public void setLogConfig(LogConfig LogConfig)
```
    Set CLS日志配置
    
    Parameters:
    
    LogConfig - CLS日志配置
  - getTuningParameters
```
public String getTuningParameters()
```
    Get 调优参数，不超过2048个字符
    
    Returns:
    
    TuningParameters 调优参数，不超过2048个字符
  - setTuningParameters
```
public void setTuningParameters(String TuningParameters)
```
    Set 调优参数，不超过2048个字符
    
    Parameters:
    
    TuningParameters - 调优参数，不超过2048个字符
  - getLogEnable
```
public Boolean getLogEnable()
```
    Get 是否上报日志
    
    Returns:
    
    LogEnable 是否上报日志
  - setLogEnable
```
public void setLogEnable(Boolean LogEnable)
```
    Set 是否上报日志
    
    Parameters:
    
    LogEnable - 是否上报日志
  - getRemark
```
public String getRemark()
```
    Get 备注，不超过1024个字符
    
    Returns:
    
    Remark 备注，不超过1024个字符
  - setRemark
```
public void setRemark(String Remark)
```
    Set 备注，不超过1024个字符
    
    Parameters:
    
    Remark - 备注，不超过1024个字符
  - getDataSource
```
public String getDataSource()
```
    Get 数据来源，eg：DATASET、COS、CFS、CFSTurbo、HDFS、GooseFSx
    
    Returns:
    
    DataSource 数据来源，eg：DATASET、COS、CFS、CFSTurbo、HDFS、GooseFSx
  - setDataSource
```
public void setDataSource(String DataSource)
```
    Set 数据来源，eg：DATASET、COS、CFS、CFSTurbo、HDFS、GooseFSx
    
    Parameters:
    
    DataSource - 数据来源，eg：DATASET、COS、CFS、CFSTurbo、HDFS、GooseFSx
  - getCallbackUrl
```
public String getCallbackUrl()
```
    Get 回调地址，用于创建/启动/停止训练任务的异步回调。回调格式&内容详见：[[TI-ONE接口回调说明]](https://cloud.tencent.com/document/product/851/84292)
    
    Returns:
    
    CallbackUrl 回调地址，用于创建/启动/停止训练任务的异步回调。回调格式&内容详见：[[TI-ONE接口回调说明]](https://cloud.tencent.com/document/product/851/84292)
  - setCallbackUrl
```
public void setCallbackUrl(String CallbackUrl)
```
    Set 回调地址，用于创建/启动/停止训练任务的异步回调。回调格式&内容详见：[[TI-ONE接口回调说明]](https://cloud.tencent.com/document/product/851/84292)
    
    Parameters:
    
    CallbackUrl - 回调地址，用于创建/启动/停止训练任务的异步回调。回调格式&内容详见：[[TI-ONE接口回调说明]](https://cloud.tencent.com/document/product/851/84292)
  - getEncodedStartCmdInfo
```
public EncodedStartCmdInfo getEncodedStartCmdInfo()
```
    Get 编码后的任务启动命令，与StartCmdInfo同时配置时，仅当前参数生效
    
    Returns:
    
    EncodedStartCmdInfo 编码后的任务启动命令，与StartCmdInfo同时配置时，仅当前参数生效
  - setEncodedStartCmdInfo
```
public void setEncodedStartCmdInfo(EncodedStartCmdInfo EncodedStartCmdInfo)
```
    Set 编码后的任务启动命令，与StartCmdInfo同时配置时，仅当前参数生效
    
    Parameters:
    
    EncodedStartCmdInfo - 编码后的任务启动命令，与StartCmdInfo同时配置时，仅当前参数生效
  - getCodeRepos
```
public CodeRepoConfig[] getCodeRepos()
```
    Get 代码仓库配置
    
    Returns:
    
    CodeRepos 代码仓库配置
  - setCodeRepos
```
public void setCodeRepos(CodeRepoConfig[] CodeRepos)
```
    Set 代码仓库配置
    
    Parameters:
    
    CodeRepos - 代码仓库配置
  - 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.

Class CreateTrainingTaskRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateTrainingTaskRequest

CreateTrainingTaskRequest

Method Detail

getName

setName

getChargeType

setChargeType

getResourceConfigInfos

setResourceConfigInfos

getFrameworkName

setFrameworkName

getFrameworkVersion

setFrameworkVersion

getFrameworkEnvironment

setFrameworkEnvironment

getResourceGroupId

setResourceGroupId

getTags

setTags

getImageInfo

setImageInfo

getCodePackagePath

setCodePackagePath

getStartCmdInfo

setStartCmdInfo

getTrainingMode

setTrainingMode

getDataConfigs

setDataConfigs

getVpcId

setVpcId

getSubnetId

setSubnetId

getOutput

setOutput

getLogConfig

setLogConfig

getTuningParameters

setTuningParameters

getLogEnable

setLogEnable

getRemark

setRemark

getDataSource

setDataSource

getCallbackUrl

setCallbackUrl

getEncodedStartCmdInfo

setEncodedStartCmdInfo

getCodeRepos

setCodeRepos

toMap