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

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 Whether to use the vouchers automatically.
String	getBlueprintId() Get Image ID.
String	getBundleId() Get Bundle ID.
String	getClientToken() Get A unique string supplied by the client to ensure that the request is idempotent.
DockerContainerConfiguration[]	getContainers() Get Configuration of the containers to create
Boolean	getDryRun() Get Whether the request is a dry run only.
InstanceChargePrepaid	getInstanceChargePrepaid() Get Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.
Long	getInstanceCount() Get Number of the instances to purchase.
String	getInstanceName() Get Instance display name.
LoginConfiguration	getLoginConfiguration() Get Login password of the instance.
String[]	getZones() Get List of availability zones.
void	setAutoVoucher(Boolean AutoVoucher) Set Whether to use the vouchers automatically.
void	setBlueprintId(String BlueprintId) Set Image ID.
void	setBundleId(String BundleId) Set Bundle ID.
void	setClientToken(String ClientToken) Set A unique string supplied by the client to ensure that the request is idempotent.
void	setContainers(DockerContainerConfiguration[] Containers) Set Configuration of the containers to create
void	setDryRun(Boolean DryRun) Set Whether the request is a dry run only.
void	setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid) Set Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.
void	setInstanceCount(Long InstanceCount) Set Number of the instances to purchase.
void	setInstanceName(String InstanceName) Set Instance display name.
void	setLoginConfiguration(LoginConfiguration LoginConfiguration) Set Login password of the instance.
void	setZones(String[] Zones) Set List of availability zones.
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

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 Bundle ID. You can get it via the [DescribeBundles](https://intl.cloud.tencent.com/document/api/1207/47575?from_cn_redirect=1) API.

Returns:

BundleId Bundle ID. You can get it via the [DescribeBundles](https://intl.cloud.tencent.com/document/api/1207/47575?from_cn_redirect=1) API.

setBundleId

public void setBundleId(String BundleId)

Set Bundle ID. You can get it via the [DescribeBundles](https://intl.cloud.tencent.com/document/api/1207/47575?from_cn_redirect=1) API.

Parameters:

BundleId - Bundle ID. You can get it via the [DescribeBundles](https://intl.cloud.tencent.com/document/api/1207/47575?from_cn_redirect=1) API.

getBlueprintId

public String getBlueprintId()

Get Image ID. You can get it via the [DescribeBlueprints](https://intl.cloud.tencent.com/document/api/1207/47689?from_cn_redirect=1) API.

Returns:

BlueprintId Image ID. You can get it via the [DescribeBlueprints](https://intl.cloud.tencent.com/document/api/1207/47689?from_cn_redirect=1) API.

setBlueprintId

public void setBlueprintId(String BlueprintId)

Set Image ID. You can get it via the [DescribeBlueprints](https://intl.cloud.tencent.com/document/api/1207/47689?from_cn_redirect=1) API.

Parameters:

BlueprintId - Image ID. You can get it via the [DescribeBlueprints](https://intl.cloud.tencent.com/document/api/1207/47689?from_cn_redirect=1) API.

getInstanceChargePrepaid

public InstanceChargePrepaid getInstanceChargePrepaid()

Get Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.

Returns:

InstanceChargePrepaid Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.

setInstanceChargePrepaid

public void setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid)

Set Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.

Parameters:

InstanceChargePrepaid - Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.

getInstanceName

public String getInstanceName()

Get Instance display name.

Returns:

InstanceName Instance display name.

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance display name.

Parameters:

InstanceName - Instance display name.

getInstanceCount

public Long getInstanceCount()

Get Number of the instances to purchase. For monthly subscribed instances, the value can be 1 to 30. The default value is `1`. Note that this number can not exceed the remaining quota under the current account.

Returns:

InstanceCount Number of the instances to purchase. For monthly subscribed instances, the value can be 1 to 30. The default value is `1`. Note that this number can not exceed the remaining quota under the current account.

setInstanceCount

public void setInstanceCount(Long InstanceCount)

Set Number of the instances to purchase. For monthly subscribed instances, the value can be 1 to 30. The default value is `1`. Note that this number can not exceed the remaining quota under the current account.

Parameters:

InstanceCount - Number of the instances to purchase. For monthly subscribed instances, the value can be 1 to 30. The default value is `1`. Note that this number can not exceed the remaining quota under the current account.

getZones

public String[] getZones()

Get List of availability zones. A random AZ is selected by default.

Returns:

Zones List of availability zones. A random AZ is selected by default.

setZones

public void setZones(String[] Zones)

Set List of availability zones. A random AZ is selected by default.

Parameters:

Zones - List of availability zones. A random AZ is selected by default.

getDryRun

public Boolean getDryRun()

Get Whether the request is a dry run only. `true`: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available. If the dry run fails, the corresponding error code will be returned. If the dry run succeeds, the RequestId will be returned. `false` (default value): send a normal request and create instance(s) if all the requirements are met.

Returns:

DryRun Whether the request is a dry run only. `true`: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available. If the dry run fails, the corresponding error code will be returned. If the dry run succeeds, the RequestId will be returned. `false` (default value): send a normal request and create instance(s) if all the requirements are met.

setDryRun

public void setDryRun(Boolean DryRun)

Set Whether the request is a dry run only. `true`: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available. If the dry run fails, the corresponding error code will be returned. If the dry run succeeds, the RequestId will be returned. `false` (default value): send a normal request and create instance(s) if all the requirements are met.

Parameters:

DryRun - Whether the request is a dry run only. `true`: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available. If the dry run fails, the corresponding error code will be returned. If the dry run succeeds, the RequestId will be returned. `false` (default value): send a normal request and create instance(s) if all the requirements are met.

getClientToken

public String getClientToken()

Get A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed.

Returns:

ClientToken A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed.

setClientToken

public void setClientToken(String ClientToken)

Set A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed.

Parameters:

ClientToken - A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed.

getLoginConfiguration

public LoginConfiguration getLoginConfiguration()

Get Login password of the instance. It’s only available for Windows instances. If it’s not specified, it means that the user choose to set the login password after the instance creation.

Returns:

LoginConfiguration Login password of the instance. It’s only available for Windows instances. If it’s not specified, it means that the user choose to set the login password after the instance creation.

setLoginConfiguration

public void setLoginConfiguration(LoginConfiguration LoginConfiguration)

Set Login password of the instance. It’s only available for Windows instances. If it’s not specified, it means that the user choose to set the login password after the instance creation.

Parameters:

LoginConfiguration - Login password of the instance. It’s only available for Windows instances. If it’s not specified, it means that the user choose to set the login password after the instance creation.

getContainers

public DockerContainerConfiguration[] getContainers()

Get Configuration of the containers to create

Returns:

Containers Configuration of the containers to create

setContainers

public void setContainers(DockerContainerConfiguration[] Containers)

Set Configuration of the containers to create

Parameters:

Containers - Configuration of the containers to create

getAutoVoucher

public Boolean getAutoVoucher()

Get Whether to use the vouchers automatically. It defaults to No.

Returns:

AutoVoucher Whether to use the vouchers automatically. It defaults to No.

setAutoVoucher

public void setAutoVoucher(Boolean AutoVoucher)

Set Whether to use the vouchers automatically. It defaults to No.

Parameters:

AutoVoucher - Whether to use the vouchers automatically. It defaults to No.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel