com.tencentcloudapi.tat.v20201028.models

Class CreateCommandRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.CreateCommandRequest

public class CreateCommandRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateCommandRequest()
CreateCommandRequest(CreateCommandRequest 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	getCommandName() Get 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
String	getCommandType() Get 命令类型，目前仅支持取值：SHELL。默认：SHELL。
String	getContent() Get Base64编码后的命令内容，长度不可超过64KB。
String	getDefaultParameters() Get 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
String	getDescription() Get 命令描述。不超过120字符。
Boolean	getEnableParameter() Get 是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。
Tag[]	getTags() Get 为命令关联的标签，列表长度不超过10。
Long	getTimeout() Get 命令超时时间，默认60秒。取值范围[1, 86400]。
String	getUsername() Get 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在Linux实例中以root用户执行命令。
String	getWorkingDirectory() Get 命令执行路径，默认：/root。
void	setCommandName(String CommandName) Set 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
void	setCommandType(String CommandType) Set 命令类型，目前仅支持取值：SHELL。默认：SHELL。
void	setContent(String Content) Set Base64编码后的命令内容，长度不可超过64KB。
void	setDefaultParameters(String DefaultParameters) Set 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
void	setDescription(String Description) Set 命令描述。不超过120字符。
void	setEnableParameter(Boolean EnableParameter) Set 是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。
void	setTags(Tag[] Tags) Set 为命令关联的标签，列表长度不超过10。
void	setTimeout(Long Timeout) Set 命令超时时间，默认60秒。取值范围[1, 86400]。
void	setUsername(String Username) Set 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在Linux实例中以root用户执行命令。
void	setWorkingDirectory(String WorkingDirectory) Set 命令执行路径，默认：/root。
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

CreateCommandRequest

public CreateCommandRequest()

CreateCommandRequest

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

getCommandName

public String getCommandName()

Get 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

Returns:

CommandName 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

setCommandName

public void setCommandName(String CommandName)

Set 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

Parameters:

CommandName - 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

getContent

public String getContent()

Get Base64编码后的命令内容，长度不可超过64KB。

Returns:

Content Base64编码后的命令内容，长度不可超过64KB。

setContent

public void setContent(String Content)

Set Base64编码后的命令内容，长度不可超过64KB。

Parameters:

Content - Base64编码后的命令内容，长度不可超过64KB。

getDescription

public String getDescription()

Get 命令描述。不超过120字符。

Returns:

Description 命令描述。不超过120字符。

setDescription

public void setDescription(String Description)

Set 命令描述。不超过120字符。

Parameters:

Description - 命令描述。不超过120字符。

getCommandType

public String getCommandType()

Get 命令类型，目前仅支持取值：SHELL。默认：SHELL。

Returns:

CommandType 命令类型，目前仅支持取值：SHELL。默认：SHELL。

setCommandType

public void setCommandType(String CommandType)

Set 命令类型，目前仅支持取值：SHELL。默认：SHELL。

Parameters:

CommandType - 命令类型，目前仅支持取值：SHELL。默认：SHELL。

getWorkingDirectory

public String getWorkingDirectory()

Get 命令执行路径，默认：/root。

Returns:

WorkingDirectory 命令执行路径，默认：/root。

setWorkingDirectory

public void setWorkingDirectory(String WorkingDirectory)

Set 命令执行路径，默认：/root。

Parameters:

WorkingDirectory - 命令执行路径，默认：/root。

getTimeout

public Long getTimeout()

Get 命令超时时间，默认60秒。取值范围[1, 86400]。

Returns:

Timeout 命令超时时间，默认60秒。取值范围[1, 86400]。

setTimeout

public void setTimeout(Long Timeout)

Set 命令超时时间，默认60秒。取值范围[1, 86400]。

Parameters:

Timeout - 命令超时时间，默认60秒。取值范围[1, 86400]。

getEnableParameter

public Boolean getEnableParameter()

Get 是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。

Returns:

EnableParameter 是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。

setEnableParameter

public void setEnableParameter(Boolean EnableParameter)

Set 是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。

Parameters:

EnableParameter - 是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。

getDefaultParameters

public String getDefaultParameters()

Get 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

Returns:

DefaultParameters 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

setDefaultParameters

public void setDefaultParameters(String DefaultParameters)

Set 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

Parameters:

DefaultParameters - 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

getTags

public Tag[] getTags()

Get 为命令关联的标签，列表长度不超过10。

Returns:

Tags 为命令关联的标签，列表长度不超过10。

setTags

public void setTags(Tag[] Tags)

Set 为命令关联的标签，列表长度不超过10。

Parameters:

Tags - 为命令关联的标签，列表长度不超过10。

getUsername

public String getUsername()

Get 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在Linux实例中以root用户执行命令。

Returns:

Username 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在Linux实例中以root用户执行命令。

setUsername

public void setUsername(String Username)

Set 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在Linux实例中以root用户执行命令。

Parameters:

Username - 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在Linux实例中以root用户执行命令。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel