com.tencentcloudapi.lighthouse.v20200324.models

Class CreateInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lighthouse.v20200324.models.CreateInstancesRequest

public class CreateInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateInstancesRequest()
CreateInstancesRequest(CreateInstancesRequest 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
Boolean	getAutoVoucher() Get 是否自动使用代金券。默认不使用。
String	getBlueprintId() Get 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。
String	getBundleId() Get 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。
String	getClientToken() Get 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。
DockerContainerConfiguration[]	getContainers() Get 要创建的容器配置列表。
Boolean	getDryRun() Get 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId.
String	getFirewallTemplateId() Get 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。
Command	getInitCommand() Get 创建实例后自动执行的命令。
InstanceChargePrepaid	getInstanceChargePrepaid() Get 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。
Long	getInstanceCount() Get 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量
String	getInstanceName() Get 实例显示名称。
LoginConfiguration	getLoginConfiguration() Get 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。
Tag[]	getTags() Get 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。
String[]	getZones() Get 可用区列表。 不填此参数，表示为随机可用区。
void	setAutoVoucher(Boolean AutoVoucher) Set 是否自动使用代金券。默认不使用。
void	setBlueprintId(String BlueprintId) Set 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。
void	setBundleId(String BundleId) Set 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。
void	setClientToken(String ClientToken) Set 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。
void	setContainers(DockerContainerConfiguration[] Containers) Set 要创建的容器配置列表。
void	setDryRun(Boolean DryRun) Set 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId.
void	setFirewallTemplateId(String FirewallTemplateId) Set 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。
void	setInitCommand(Command InitCommand) Set 创建实例后自动执行的命令。
void	setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid) Set 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。
void	setInstanceCount(Long InstanceCount) Set 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量
void	setInstanceName(String InstanceName) Set 实例显示名称。
void	setLoginConfiguration(LoginConfiguration LoginConfiguration) Set 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。
void	setTags(Tag[] Tags) Set 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。
void	setZones(String[] Zones) 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

CreateInstancesRequest

public CreateInstancesRequest()

CreateInstancesRequest

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

getBundleId

public String getBundleId()

Get 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。

Returns:

BundleId 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。

setBundleId

public void setBundleId(String BundleId)

Set 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。

Parameters:

BundleId - 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。

getBlueprintId

public String getBlueprintId()

Get 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。

Returns:

BlueprintId 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。

setBlueprintId

public void setBlueprintId(String BlueprintId)

Set 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。

Parameters:

BlueprintId - 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。

getInstanceChargePrepaid

public InstanceChargePrepaid getInstanceChargePrepaid()

Get 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。

Returns:

InstanceChargePrepaid 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。

setInstanceChargePrepaid

public void setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid)

Set 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。

Parameters:

InstanceChargePrepaid - 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。

getInstanceName

public String getInstanceName()

Get 实例显示名称。

Returns:

InstanceName 实例显示名称。

setInstanceName

public void setInstanceName(String InstanceName)

Set 实例显示名称。

Parameters:

InstanceName - 实例显示名称。

getInstanceCount

public Long getInstanceCount()

Get 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量

Returns:

InstanceCount 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量

setInstanceCount

public void setInstanceCount(Long InstanceCount)

Set 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量

Parameters:

InstanceCount - 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量

getZones

public String[] getZones()

Get 可用区列表。 不填此参数，表示为随机可用区。

Returns:

Zones 可用区列表。 不填此参数，表示为随机可用区。

setZones

public void setZones(String[] Zones)

Set 可用区列表。 不填此参数，表示为随机可用区。

Parameters:

Zones - 可用区列表。 不填此参数，表示为随机可用区。

getDryRun

public Boolean getDryRun()

Get 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例

Returns:

DryRun 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例

setDryRun

public void setDryRun(Boolean DryRun)

Set 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例

Parameters:

DryRun - 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例

getClientToken

public String getClientToken()

Get 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。

Returns:

ClientToken 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。

setClientToken

public void setClientToken(String ClientToken)

Set 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。

Parameters:

ClientToken - 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。

getLoginConfiguration

public LoginConfiguration getLoginConfiguration()

Get 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。

Returns:

LoginConfiguration 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。

setLoginConfiguration

public void setLoginConfiguration(LoginConfiguration LoginConfiguration)

Set 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。

Parameters:

LoginConfiguration - 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。

getContainers

public DockerContainerConfiguration[] getContainers()

Get 要创建的容器配置列表。

Returns:

Containers 要创建的容器配置列表。

setContainers

public void setContainers(DockerContainerConfiguration[] Containers)

Set 要创建的容器配置列表。

Parameters:

Containers - 要创建的容器配置列表。

getAutoVoucher

public Boolean getAutoVoucher()

Get 是否自动使用代金券。默认不使用。

Returns:

AutoVoucher 是否自动使用代金券。默认不使用。

setAutoVoucher

public void setAutoVoucher(Boolean AutoVoucher)

Set 是否自动使用代金券。默认不使用。

Parameters:

AutoVoucher - 是否自动使用代金券。默认不使用。

getFirewallTemplateId

public String getFirewallTemplateId()

Get 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。

Returns:

FirewallTemplateId 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。

setFirewallTemplateId

public void setFirewallTemplateId(String FirewallTemplateId)

Set 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。

Parameters:

FirewallTemplateId - 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。

getTags

public Tag[] getTags()

Get 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。

Returns:

Tags 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。

setTags

public void setTags(Tag[] Tags)

Set 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。

Parameters:

Tags - 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。

getInitCommand

public Command getInitCommand()

Get 创建实例后自动执行的命令。

Returns:

InitCommand 创建实例后自动执行的命令。

setInitCommand

public void setInitCommand(Command InitCommand)

Set 创建实例后自动执行的命令。

Parameters:

InitCommand - 创建实例后自动执行的命令。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel