com.tencentcloudapi.tat.v20201028.models

Class InvokeCommandRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.InvokeCommandRequest

public class InvokeCommandRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
InvokeCommandRequest()
InvokeCommandRequest(InvokeCommandRequest 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[]	getInstanceIds() Get 待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例
String	getOutputCOSBucketUrl() Get 指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
String	getOutputCOSKeyPrefix() Get 指定日志在cos bucket中的目录，目录命名有如下规则： 1.
String	getParameters() Get Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
Long	getTimeout() Get 命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。
String	getUsername() Get 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
String	getWorkingDirectory() Get 命令执行路径, 默认以Command配置的WorkingDirectory执行。
void	setCommandId(String CommandId) Set 待触发的命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
void	setInstanceIds(String[] InstanceIds) Set 待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例
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	setParameters(String Parameters) Set Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
void	setTimeout(Long Timeout) Set 命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。
void	setUsername(String Username) Set 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
void	setWorkingDirectory(String WorkingDirectory) Set 命令执行路径, 默认以Command配置的WorkingDirectory执行。
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

InvokeCommandRequest

public InvokeCommandRequest()

InvokeCommandRequest

public InvokeCommandRequest(InvokeCommandRequest 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) 接口获取。

getInstanceIds

public String[] getInstanceIds()

Get 待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例

Returns:

InstanceIds 待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例

Parameters:

InstanceIds - 待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例

getParameters

public String getParameters()

Get Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

Returns:

Parameters Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

setParameters

public void setParameters(String Parameters)

Set Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

Parameters:

Parameters - Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。

getUsername

public String getUsername()

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

Returns:

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

setUsername

public void setUsername(String Username)

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

Parameters:

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

getWorkingDirectory

public String getWorkingDirectory()

Get 命令执行路径, 默认以Command配置的WorkingDirectory执行。

Returns:

WorkingDirectory 命令执行路径, 默认以Command配置的WorkingDirectory执行。

setWorkingDirectory

public void setWorkingDirectory(String WorkingDirectory)

Set 命令执行路径, 默认以Command配置的WorkingDirectory执行。

Parameters:

WorkingDirectory - 命令执行路径, 默认以Command配置的WorkingDirectory执行。

getTimeout

public Long getTimeout()

Get 命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

Returns:

Timeout 命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

setTimeout

public void setTimeout(Long Timeout)

Set 命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

Parameters:

Timeout - 命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

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.