com.tencentcloudapi.tat.v20201028.models

Class CreateInvokerRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.CreateInvokerRequest

public class CreateInvokerRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateInvokerRequest()
CreateInvokerRequest(CreateInvokerRequest 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。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。
String	getName() Get 执行器名称。长度不超过 120 字符。
String	getParameters() Get 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
ScheduleSettings	getScheduleSettings() Get 周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。
String	getType() Get 执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。
String	getUsername() Get 命令执行用户。长度不超过 256 字符。
void	setCommandId(String CommandId) Set 远程命令ID。 可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。
void	setInstanceIds(String[] InstanceIds) Set 触发器关联的实例ID。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。
void	setName(String Name) Set 执行器名称。长度不超过 120 字符。
void	setParameters(String Parameters) Set 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。
void	setScheduleSettings(ScheduleSettings ScheduleSettings) Set 周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。
void	setType(String Type) Set 执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。
void	setUsername(String Username) Set 命令执行用户。长度不超过 256 字符。
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

CreateInvokerRequest

public CreateInvokerRequest()

CreateInvokerRequest

public CreateInvokerRequest(CreateInvokerRequest 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 执行器名称。长度不超过 120 字符。

Returns:

Name 执行器名称。长度不超过 120 字符。

setName

public void setName(String Name)

Set 执行器名称。长度不超过 120 字符。

Parameters:

Name - 执行器名称。长度不超过 120 字符。

getType

public String getType()

Get 执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。

Returns:

Type 执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。

setType

public void setType(String Type)

Set 执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。

Parameters:

Type - 执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。

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。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。

Returns:

InstanceIds 触发器关联的实例ID。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 触发器关联的实例ID。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。

Parameters:

InstanceIds - 触发器关联的实例ID。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。

getUsername

public String getUsername()

Get 命令执行用户。长度不超过 256 字符。

Returns:

Username 命令执行用户。长度不超过 256 字符。

setUsername

public void setUsername(String Username)

Set 命令执行用户。长度不超过 256 字符。

Parameters:

Username - 命令执行用户。长度不超过 256 字符。

getParameters

public String getParameters()

Get 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。

Returns:

Parameters 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。

setParameters

public void setParameters(String Parameters)

Set 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。

Parameters:

Parameters - 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。

getScheduleSettings

public ScheduleSettings getScheduleSettings()

Get 周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。

Returns:

ScheduleSettings 周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。

setScheduleSettings

public void setScheduleSettings(ScheduleSettings ScheduleSettings)

Set 周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。

Parameters:

ScheduleSettings - 周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。

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.