com.tencentcloudapi.tat.v20201028.models

Class ModifyCommandRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.ModifyCommandRequest

public class ModifyCommandRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ModifyCommandRequest()
ModifyCommandRequest(ModifyCommandRequest 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	getCommandId() Get 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
String	getCommandName() Get 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
String	getCommandType() Get 命令类型，目前支持取值：SHELL、POWERSHELL、BAT。
String	getContent() Get Base64编码后的命令内容，长度不可超过64KB。
DefaultParameterConf[]	getDefaultParameterConfs() Get 自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 自定义参数最多20个。
String	getDefaultParameters() Get 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 采取整体全覆盖式修改，即修改时必须提供所有新默认值。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
String	getDescription() Get 命令描述。不超过120字符。
String	getOutputCOSBucketUrl() Get 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
String	getOutputCOSKeyPrefix() Get 指定日志在cos bucket中的目录，目录命名有如下规则： 1.
Long	getTimeout() Get 命令超时时间。取值范围[1, 86400]。
String	getUsername() Get 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。
String	getWorkingDirectory() Get 命令执行路径。
void	setCommandId(String CommandId) Set 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
void	setCommandName(String CommandName) Set 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
void	setCommandType(String CommandType) Set 命令类型，目前支持取值：SHELL、POWERSHELL、BAT。
void	setContent(String Content) Set Base64编码后的命令内容，长度不可超过64KB。
void	setDefaultParameterConfs(DefaultParameterConf[] DefaultParameterConfs) Set 自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 自定义参数最多20个。
void	setDefaultParameters(String DefaultParameters) Set 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 采取整体全覆盖式修改，即修改时必须提供所有新默认值。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
void	setDescription(String Description) Set 命令描述。不超过120字符。
void	setOutputCOSBucketUrl(String OutputCOSBucketUrl) Set 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
void	setOutputCOSKeyPrefix(String OutputCOSKeyPrefix) Set 指定日志在cos bucket中的目录，目录命名有如下规则： 1.
void	setTimeout(Long Timeout) Set 命令超时时间。取值范围[1, 86400]。
void	setUsername(String Username) Set 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。
void	setWorkingDirectory(String WorkingDirectory) Set 命令执行路径。
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

ModifyCommandRequest

public ModifyCommandRequest()

ModifyCommandRequest

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

getCommandId

public String getCommandId()

Get 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。

Returns:

CommandId 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。

setCommandId

public void setCommandId(String CommandId)

Set 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。

Parameters:

CommandId - 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。

getCommandName

public String getCommandName()

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

Returns:

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

setCommandName

public void setCommandName(String CommandName)

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

Parameters:

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

getDescription

public String getDescription()

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

Returns:

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

setDescription

public void setDescription(String Description)

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

Parameters:

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

getContent

public String getContent()

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

Returns:

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

setContent

public void setContent(String Content)

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

Parameters:

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

getCommandType

public String getCommandType()

Get 命令类型，目前支持取值：SHELL、POWERSHELL、BAT。

Returns:

CommandType 命令类型，目前支持取值：SHELL、POWERSHELL、BAT。

setCommandType

public void setCommandType(String CommandType)

Set 命令类型，目前支持取值：SHELL、POWERSHELL、BAT。

Parameters:

CommandType - 命令类型，目前支持取值：SHELL、POWERSHELL、BAT。

getWorkingDirectory

public String getWorkingDirectory()

Get 命令执行路径。

Returns:

WorkingDirectory 命令执行路径。

setWorkingDirectory

public void setWorkingDirectory(String WorkingDirectory)

Set 命令执行路径。

Parameters:

WorkingDirectory - 命令执行路径。

getTimeout

public Long getTimeout()

Get 命令超时时间。取值范围[1, 86400]。

Returns:

Timeout 命令超时时间。取值范围[1, 86400]。

setTimeout

public void setTimeout(Long Timeout)

Set 命令超时时间。取值范围[1, 86400]。

Parameters:

Timeout - 命令超时时间。取值范围[1, 86400]。

getDefaultParameters

public String getDefaultParameters()

Get 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 采取整体全覆盖式修改，即修改时必须提供所有新默认值。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

Returns:

DefaultParameters 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 采取整体全覆盖式修改，即修改时必须提供所有新默认值。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

setDefaultParameters

public void setDefaultParameters(String DefaultParameters)

Set 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 采取整体全覆盖式修改，即修改时必须提供所有新默认值。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

Parameters:

DefaultParameters - 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 采取整体全覆盖式修改，即修改时必须提供所有新默认值。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

getDefaultParameterConfs

public DefaultParameterConf[] getDefaultParameterConfs()

Get 自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 自定义参数最多20个。

Returns:

DefaultParameterConfs 自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 自定义参数最多20个。

setDefaultParameterConfs

public void setDefaultParameterConfs(DefaultParameterConf[] DefaultParameterConfs)

Set 自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 自定义参数最多20个。

Parameters:

DefaultParameterConfs - 自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 自定义参数最多20个。

getUsername

public String getUsername()

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

Returns:

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

setUsername

public void setUsername(String Username)

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

Parameters:

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

getOutputCOSBucketUrl

public String getOutputCOSBucketUrl()

Get 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

Returns:

OutputCOSBucketUrl 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

setOutputCOSBucketUrl

public void setOutputCOSBucketUrl(String OutputCOSBucketUrl)

Set 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

Parameters:

OutputCOSBucketUrl - 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

getOutputCOSKeyPrefix

public String getOutputCOSKeyPrefix()

Get 指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Returns:

OutputCOSKeyPrefix 指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

setOutputCOSKeyPrefix

public void setOutputCOSKeyPrefix(String OutputCOSKeyPrefix)

Set 指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

OutputCOSKeyPrefix - 指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

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.