CreateInstanceRequest (bce-sdk-java 0.10.217 API)

java.lang.Object
- com.baidubce.model.AbstractBceRequest
- - com.baidubce.services.bcc.model.instance.CreateInstanceRequest

public class CreateInstanceRequest
extends AbstractBceRequest

The request for creating a newly instance.

Constructor Summary

Constructors
Constructor and Description

CreateInstanceRequest()

Constructors
Constructor and Description
`CreateInstanceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAdminPass()`
`String`	`getAspId()`
`int`	`getAutoRenewTime()`
`String`	`getAutoRenewTimeUnit()`
`String`	`getBidModel()`
`String`	`getBidPrice()`
`Billing`	`getBilling()`
`int`	`getCardCount()`
`String`	`getClientToken()`
`int`	`getCpuCount()`
`List<CreateCdsModel>`	`getCreateCdsList()`
`String`	`getDedicatedHostId()`
`String`	`getDeployId()`
`List<EphemeralDisk>`	`getEphemeralDisks()`
`FpgaCardType`	`getFpgaCard()`
`GpuCardType`	`getGpuCard()`
`String`	`getHostname()`
`String`	`getImageId()`
`String`	`getInstanceType()`
`String`	`getInternetChargeType()`
`String`	`getKeypairId()`
`int`	`getLocalDiskSizeInGB()` Deprecated.
`int`	`getMemoryCapacityInGB()`
`String`	`getName()`
`int`	`getNetworkCapacityInMbps()`
`int`	`getPurchaseCount()`
`int`	`getRootDiskSizeInGb()`
`String`	`getRootDiskStorageType()`
`String`	`getSecurityGroupId()`
`String`	`getSpec()`
`String`	`getSubnetId()`
`List<TagModel>`	`getTags()`
`String`	`getZoneName()`
`boolean`	`isAutoSeqSuffix()`
`boolean`	`isCdsAutoRenew()`
`boolean`	`isRelationTag()`
`void`	`setAdminPass(String adminPass)`
`void`	`setAspId(String aspId)`
`void`	`setAutoRenewTime(int autoRenewTime)`
`void`	`setAutoRenewTimeUnit(String autoRenewTimeUnit)`
`void`	`setAutoSeqSuffix(boolean autoSeqSuffix)`
`void`	`setBidModel(String bidModel)`
`void`	`setBidPrice(String bidPrice)`
`void`	`setBilling(Billing billing)`
`void`	`setCardCount(int cardCount)`
`void`	`setCdsAutoRenew(boolean cdsAutoRenew)`
`void`	`setClientToken(String clientToken)`
`void`	`setCpuCount(int cpuCount)`
`void`	`setCreateCdsList(List<CreateCdsModel> createCdsList)`
`void`	`setDedicatedHostId(String dedicatedHostId)`
`void`	`setDeployId(String deployId)`
`void`	`setEphemeralDisks(List<EphemeralDisk> ephemeralDisks)`
`void`	`setFpgaCard(FpgaCardType fpgaCard)`
`void`	`setGpuCard(GpuCardType gpuCard)`
`void`	`setHostname(String hostname)`
`void`	`setImageId(String imageId)`
`void`	`setInstanceType(String instanceType)`
`void`	`setInternetChargeType(String internetChargeType)`
`void`	`setKeypairId(String keypairId)`
`void`	`setLocalDiskSizeInGB(int localDiskSizeInGB)` Deprecated.
`void`	`setMemoryCapacityInGB(int memoryCapacityInGB)`
`void`	`setName(String name)`
`void`	`setNetworkCapacityInMbps(int networkCapacityInMbps)`
`void`	`setPurchaseCount(int purchaseCount)`
`void`	`setRelationTag(boolean relationTag)`
`void`	`setRootDiskSizeInGb(int rootDiskSizeInGb)`
`void`	`setRootDiskStorageType(String rootDiskStorageType)`
`void`	`setSecurityGroupId(String securityGroupId)`
`void`	`setSpec(String spec)`
`void`	`setSubnetId(String subnetId)`
`void`	`setTags(List<TagModel> tags)`
`void`	`setZoneName(String zoneName)`
`CreateInstanceRequest`	`withAdminPass(String adminPass)` Configure adminPass for the request.
`CreateInstanceRequest`	`withAspId(String aspId)` Configure the aspId for the request
`CreateInstanceRequest`	`withAutoRenewTime(int autoRenewTime)` Configure the autoRenewTime for the request
`CreateInstanceRequest`	`withAutoRenewTimeUnit(String autoRenewTimeUnit)` Configure the autoRenewTimeUnit for the request
`CreateInstanceRequest`	`withAutoSeqSuffix(boolean autoSeqSuffix)`
`CreateInstanceRequest`	`withBidModel(String bidModel)` Configure the bidModel for the request
`CreateInstanceRequest`	`withBidPrice(String bidPrice)` Configure the bidPrice for the request
`CreateInstanceRequest`	`withBilling(Billing billing)` Configure billing for the request.
`CreateInstanceRequest`	`withCardCount(int cardCount)` Configure the card count of gpuCardType or gpgaCardType for the request, if creating gpu / fpga instance, one or more card count must be specified.
`CreateInstanceRequest`	`withCdsAutoRenew(boolean cdsAutoRenew)` Configure the cdsAutoRenew for the request
`CreateInstanceRequest`	`withClientToken(String clientToken)` Configure optional client token for the request.
`CreateInstanceRequest`	`withCpuCount(int cpuCount)`
`CreateInstanceRequest`	`withCreateCdsList(List<CreateCdsModel> createCdsList)` Configure createCdsList for the request.
`CreateInstanceRequest`	`withDedicatedHostId(String dedicatedHostId)`
`CreateInstanceRequest`	`withDeployId(String deployId)` Configure the deployId for the request
`CreateInstanceRequest`	`withEphemeralDisks(List<EphemeralDisk> ephemeralDisks)`
`CreateInstanceRequest`	`withFpgaCard(FpgaCardType fpgaCard)` Configure the fpgaCard for the request, see all of supported fpga card type in `FpgaCardType`
`CreateInstanceRequest`	`withGpuCard(GpuCardType gpuCard)` Configure the gpuCard for the request, see all of supported gpu card type in `GpuCardType`
`CreateInstanceRequest`	`withHostname(String hostname)`
`CreateInstanceRequest`	`withImageId(String imageId)` Configure imageId for the request.
`CreateInstanceRequest`	`withInstanceType(String instanceType)` Configure instanceType for the request.
`CreateInstanceRequest`	`withInternetChargeType(String internetChargeType)` Configure the internetChargeType for the request
`CreateInstanceRequest`	`withKeypairId(String keypairId)` Configure the keypairId for the request
`CreateInstanceRequest`	`withLocalDiskSizeInGB(int localDiskSizeInGB)` Deprecated.
`CreateInstanceRequest`	`withMemoryCapacityInGB(int memoryCapacityInGB)`
`CreateInstanceRequest`	`withName(String name)` Configure name for the request.
`CreateInstanceRequest`	`withNetworkCapacityInMbps(int networkCapacityInMbps)` Configure networkCapacityInMbps for the request.
`CreateInstanceRequest`	`withPurchaseCount(int purchaseCount)` Configure purchaseCount for the request.
`CreateInstanceRequest`	`withRelationTag(boolean relationTag)` Configure relationTag for the request.
`CreateInstanceRequest`	`withRequestCredentials(BceCredentials credentials)` Configure request credential for the request.
`CreateInstanceRequest`	`withRootDiskSizeInGb(int rootDiskSizeInGb)`
`CreateInstanceRequest`	`withRootDiskStorageType(String rootDiskStorageType)`
`CreateInstanceRequest`	`withSecurityGroupId(String securityGroupId)` Configure the securityGroupId for the request
`CreateInstanceRequest`	`withSpec(String Spec)`
`CreateInstanceRequest`	`withSubnetId(String subnetId)` Configure the subnetId for the request
`CreateInstanceRequest`	`withTags(List<TagModel> tags)` Configure tags for the request.
`CreateInstanceRequest`	`withZoneName(String zoneName)` Configure the zone name for the request

Methods inherited from class com.baidubce.model.AbstractBceRequest
getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateInstanceRequest
```
public CreateInstanceRequest()
```
- Method Detail
  - withClientToken
```
public CreateInstanceRequest withClientToken(String clientToken)
```
    Configure optional client token for the request. The request will be idempotent if client token is provided. If the clientToken is not specified by the user, a random String generated by default algorithm will be used.
    
    Parameters:
    
    clientToken - An ASCII string whose length is less than 64. See more detail at BCE API doc
    
    Returns:
    
    CreateInstanceRequest with specific clientToken
  - getClientToken
```
public String getClientToken()
```
  - setClientToken
```
public void setClientToken(String clientToken)
```
  - withInstanceType
```
public CreateInstanceRequest withInstanceType(String instanceType)
```
    Configure instanceType for the request.
    
    Parameters:
    
    instanceType - The specified Specification to create the instance. See more detail on BCE API doc
    
    Returns:
    
    CreateInstanceRequest with specific instanceType
  - getInstanceType
```
public String getInstanceType()
```
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
  - withSpec
```
public CreateInstanceRequest withSpec(String Spec)
```
  - getSpec
```
public String getSpec()
```
  - setSpec
```
public void setSpec(String spec)
```
  - withCpuCount
```
public CreateInstanceRequest withCpuCount(int cpuCount)
```
  - getCpuCount
```
public int getCpuCount()
```
  - setCpuCount
```
public void setCpuCount(int cpuCount)
```
  - withMemoryCapacityInGB
```
public CreateInstanceRequest withMemoryCapacityInGB(int memoryCapacityInGB)
```
  - getMemoryCapacityInGB
```
public int getMemoryCapacityInGB()
```
  - setMemoryCapacityInGB
```
public void setMemoryCapacityInGB(int memoryCapacityInGB)
```
  - withEphemeralDisks
```
public CreateInstanceRequest withEphemeralDisks(List<EphemeralDisk> ephemeralDisks)
```
  - withRootDiskSizeInGb
```
public CreateInstanceRequest withRootDiskSizeInGb(int rootDiskSizeInGb)
```
  - getRootDiskSizeInGb
```
public int getRootDiskSizeInGb()
```
  - setRootDiskSizeInGb
```
public void setRootDiskSizeInGb(int rootDiskSizeInGb)
```
  - withRootDiskStorageType
```
public CreateInstanceRequest withRootDiskStorageType(String rootDiskStorageType)
```
  - getRootDiskStorageType
```
public String getRootDiskStorageType()
```
  - setRootDiskStorageType
```
public void setRootDiskStorageType(String rootDiskStorageType)
```
  - getEphemeralDisks
```
public List<EphemeralDisk> getEphemeralDisks()
```
  - setEphemeralDisks
```
public void setEphemeralDisks(List<EphemeralDisk> ephemeralDisks)
```
  - withImageId
```
public CreateInstanceRequest withImageId(String imageId)
```
    Configure imageId for the request.
    
    Parameters:
    
    imageId - The specified image id to create the instance.
    
    Returns:
    
    CreateInstanceRequest with specific imageId
  - getImageId
```
public String getImageId()
```
  - setImageId
```
public void setImageId(String imageId)
```
  - getLocalDiskSizeInGB
```
@Deprecated
public int getLocalDiskSizeInGB()
```
    Deprecated.
  - setLocalDiskSizeInGB
```
@Deprecated
public void setLocalDiskSizeInGB(int localDiskSizeInGB)
```
    Deprecated.
  - withLocalDiskSizeInGB
```
@Deprecated
public CreateInstanceRequest withLocalDiskSizeInGB(int localDiskSizeInGB)
```
    Deprecated.
    
    Configure localDiskSizeInGB for the request.
    
    Parameters:
    
    localDiskSizeInGB - The optional parameter to specify the temporary disk size in GB.
    
    Returns:
    
    CreateInstanceRequest with specific localDiskSizeInGB
  - getCreateCdsList
```
public List<CreateCdsModel> getCreateCdsList()
```
  - setCreateCdsList
```
public void setCreateCdsList(List<CreateCdsModel> createCdsList)
```
  - withCreateCdsList
```
public CreateInstanceRequest withCreateCdsList(List<CreateCdsModel> createCdsList)
```
    Configure createCdsList for the request.
    
    Parameters:
    
    createCdsList - The optional list of volume detail info to create.
    
    Returns:
    
    CreateInstanceRequest with specific createCdsList
  - getNetworkCapacityInMbps
```
public int getNetworkCapacityInMbps()
```
  - setNetworkCapacityInMbps
```
public void setNetworkCapacityInMbps(int networkCapacityInMbps)
```
  - withNetworkCapacityInMbps
```
public CreateInstanceRequest withNetworkCapacityInMbps(int networkCapacityInMbps)
```
    Configure networkCapacityInMbps for the request.
    
    Parameters:
    
    networkCapacityInMbps - The optional parameter to specify the bandwidth in Mbps for the new instance.
    
    Returns:
    
    CreateInstanceRequest with specific networkCapacityInMbps
  - getPurchaseCount
```
public int getPurchaseCount()
```
  - setPurchaseCount
```
public void setPurchaseCount(int purchaseCount)
```
  - withPurchaseCount
```
public CreateInstanceRequest withPurchaseCount(int purchaseCount)
```
    Configure purchaseCount for the request.
    
    Parameters:
    
    purchaseCount - The number of instance to buy, the default value is 1.
    
    Returns:
    
    CreateInstanceRequest with specific purchaseCount
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getHostname
```
public String getHostname()
```
  - setHostname
```
public void setHostname(String hostname)
```
  - withHostname
```
public CreateInstanceRequest withHostname(String hostname)
```
  - isAutoSeqSuffix
```
public boolean isAutoSeqSuffix()
```
  - setAutoSeqSuffix
```
public void setAutoSeqSuffix(boolean autoSeqSuffix)
```
  - withAutoSeqSuffix
```
public CreateInstanceRequest withAutoSeqSuffix(boolean autoSeqSuffix)
```
  - withName
```
public CreateInstanceRequest withName(String name)
```
    Configure name for the request.
    
    Parameters:
    
    name - The optional parameter to desc the instance that will be created.
    
    Returns:
    
    CreateInstanceRequest with specific name
  - getAdminPass
```
public String getAdminPass()
```
  - setAdminPass
```
public void setAdminPass(String adminPass)
```
  - withAdminPass
```
public CreateInstanceRequest withAdminPass(String adminPass)
```
    Configure adminPass for the request.
    
    Parameters:
    
    adminPass - The optional parameter to specify the password for the instance. The adminPass will be encrypted in AES-128 algorithm with the substring of the former 16 characters of user SecretKey. See more detail on BCE API doc
    
    Returns:
    
    CreateInstanceRequest with specific adminPass
  - getBilling
```
public Billing getBilling()
```
  - setBilling
```
public void setBilling(Billing billing)
```
  - withBilling
```
public CreateInstanceRequest withBilling(Billing billing)
```
    Configure billing for the request.
    
    Parameters:
    
    billing - The detail model to specify the billing.
    
    Returns:
    
    CreateInstanceRequest with specific billing
  - isRelationTag
```
public boolean isRelationTag()
```
  - setRelationTag
```
public void setRelationTag(boolean relationTag)
```
  - withRelationTag
```
public CreateInstanceRequest withRelationTag(boolean relationTag)
```
    Configure relationTag for the request.
    
    Parameters:
    
    relationTag - Indicates whether the tag is bound to all relation instances.
    
    Returns:
    
    CreateInstanceRequest with specific relationTag
  - getTags
```
public List<TagModel> getTags()
```
  - setTags
```
public void setTags(List<TagModel> tags)
```
  - withTags
```
public CreateInstanceRequest withTags(List<TagModel> tags)
```
    Configure tags for the request.
    
    Parameters:
    
    tags - The list of tag to be bonded.
    
    Returns:
    
    CreateInstanceRequest with specific tags
  - withDedicatedHostId
```
public CreateInstanceRequest withDedicatedHostId(String dedicatedHostId)
```
  - getDedicatedHostId
```
public String getDedicatedHostId()
```
  - setDedicatedHostId
```
public void setDedicatedHostId(String dedicatedHostId)
```
  - withZoneName
```
public CreateInstanceRequest withZoneName(String zoneName)
```
    Configure the zone name for the request
    
    Parameters:
    
    zoneName -
    
    Returns:
    
    CreateInstanceRequest with specified zone name
  - getZoneName
```
public String getZoneName()
```
  - setZoneName
```
public void setZoneName(String zoneName)
```
  - withSubnetId
```
public CreateInstanceRequest withSubnetId(String subnetId)
```
    Configure the subnetId for the request
    
    Parameters:
    
    subnetId -
    
    Returns:
    
    CreateInstanceRequest with specified subnetId
  - getSubnetId
```
public String getSubnetId()
```
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
  - withSecurityGroupId
```
public CreateInstanceRequest withSecurityGroupId(String securityGroupId)
```
    Configure the securityGroupId for the request
    
    Parameters:
    
    securityGroupId -
    
    Returns:
    
    CreateInstanceRequest with specified securityGroupId
  - getSecurityGroupId
```
public String getSecurityGroupId()
```
  - setSecurityGroupId
```
public void setSecurityGroupId(String securityGroupId)
```
  - getGpuCard
```
public GpuCardType getGpuCard()
```
  - setGpuCard
```
public void setGpuCard(GpuCardType gpuCard)
```
  - withGpuCard
```
public CreateInstanceRequest withGpuCard(GpuCardType gpuCard)
```
    Configure the gpuCard for the request, see all of supported gpu card type in GpuCardType
    
    Parameters:
    
    gpuCard -
    
    Returns:
    
    CreateInstanceRequest with specified gpuCard
  - getFpgaCard
```
public FpgaCardType getFpgaCard()
```
  - setFpgaCard
```
public void setFpgaCard(FpgaCardType fpgaCard)
```
  - withFpgaCard
```
public CreateInstanceRequest withFpgaCard(FpgaCardType fpgaCard)
```
    Configure the fpgaCard for the request, see all of supported fpga card type in FpgaCardType
    
    Parameters:
    
    fpgaCard -
    
    Returns:
    
    CreateInstanceRequest with specified fpgaCard
  - getCardCount
```
public int getCardCount()
```
  - setCardCount
```
public void setCardCount(int cardCount)
```
  - withCardCount
```
public CreateInstanceRequest withCardCount(int cardCount)
```
    Configure the card count of gpuCardType or gpgaCardType for the request, if creating gpu / fpga instance, one or more card count must be specified.
    
    Parameters:
    
    cardCount -
    
    Returns:
    
    CreateInstanceRequest with card count of gpuCardType or gpgaCardTyp.
  - getAspId
```
public String getAspId()
```
  - setAspId
```
public void setAspId(String aspId)
```
  - withAspId
```
public CreateInstanceRequest withAspId(String aspId)
```
    Configure the aspId for the request
    
    Parameters:
    
    aspId - The id of the asp.
    
    Returns:
    
    CreateInstanceRequest with specified aspId
  - getAutoRenewTime
```
public int getAutoRenewTime()
```
  - setAutoRenewTime
```
public void setAutoRenewTime(int autoRenewTime)
```
  - withAutoRenewTime
```
public CreateInstanceRequest withAutoRenewTime(int autoRenewTime)
```
    Configure the autoRenewTime for the request
    
    Parameters:
    
    autoRenewTime - The specified auto renew time length.
    
    Returns:
    
    CreateInstanceRequest with specified autoRenewTime
  - getAutoRenewTimeUnit
```
public String getAutoRenewTimeUnit()
```
  - setAutoRenewTimeUnit
```
public void setAutoRenewTimeUnit(String autoRenewTimeUnit)
```
  - withAutoRenewTimeUnit
```
public CreateInstanceRequest withAutoRenewTimeUnit(String autoRenewTimeUnit)
```
    Configure the autoRenewTimeUnit for the request
    
    Parameters:
    
    autoRenewTimeUnit - The specified auto renew time unit. The unit can be "month" or "year".
    
    Returns:
    
    CreateInstanceRequest with specified autoRenewTimeUnit
  - isCdsAutoRenew
```
public boolean isCdsAutoRenew()
```
  - setCdsAutoRenew
```
public void setCdsAutoRenew(boolean cdsAutoRenew)
```
  - withCdsAutoRenew
```
public CreateInstanceRequest withCdsAutoRenew(boolean cdsAutoRenew)
```
    Configure the cdsAutoRenew for the request
    
    Parameters:
    
    cdsAutoRenew - The option param to indicate that whether the cds is auto renew or not. If true, it means the instance is auto renew.
    Returns: CreateInstanceRequest with specified cdsAutoRenew
  getDeployId public String getDeployId() setDeployId public void setDeployId(String deployId) withDeployId public CreateInstanceRequest withDeployId(String deployId) Configure the deployId for the request Parameters: deployId - The specified deployment set id. Returns: CreateInstanceRequest with specified deployId getInternetChargeType public String getInternetChargeType() setInternetChargeType public void setInternetChargeType(String internetChargeType) withInternetChargeType public CreateInstanceRequest withInternetChargeType(String internetChargeType) Configure the internetChargeType for the request Parameters: internetChargeType - The specified internet charge type. Returns: CreateInstanceRequest with specified internetChargeType getKeypairId public String getKeypairId() setKeypairId public void setKeypairId(String keypairId) withKeypairId public CreateInstanceRequest withKeypairId(String keypairId) Configure the keypairId for the request Parameters: keypairId - The specified keypair id. Returns: CreateInstanceRequest with specified keypairId getBidModel public String getBidModel() setBidModel public void setBidModel(String bidModel) withBidModel public CreateInstanceRequest withBidModel(String bidModel) Configure the bidModel for the request Parameters: bidModel - The specified bidModel. The value can be "market" or "custom". Returns: CreateInstanceRequest with specified bidModel getBidPrice public String getBidPrice() setBidPrice public void setBidPrice(String bidPrice) withBidPrice public CreateInstanceRequest withBidPrice(String bidPrice) Configure the bidPrice for the request Parameters: bidPrice - The specified bidPrice. Only the value of bidModel is custom, the param works. Returns: CreateInstanceRequest with specified bidPrice withRequestCredentials public CreateInstanceRequest withRequestCredentials(BceCredentials credentials) Configure request credential for the request. Specified by: withRequestCredentials in class AbstractBceRequest Parameters: credentials - a valid instance of BceCredentials. Returns: CreateInstanceRequest with credentials.

Class CreateInstanceRequest

Constructor Summary

Method Summary

Methods inherited from class com.baidubce.model.AbstractBceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateInstanceRequest

Method Detail

withClientToken

getClientToken

setClientToken

withInstanceType

getInstanceType

setInstanceType

withSpec

getSpec

setSpec

withCpuCount

getCpuCount

setCpuCount

withMemoryCapacityInGB

getMemoryCapacityInGB

setMemoryCapacityInGB

withEphemeralDisks

withRootDiskSizeInGb

getRootDiskSizeInGb

setRootDiskSizeInGb

withRootDiskStorageType

getRootDiskStorageType

setRootDiskStorageType

getEphemeralDisks

setEphemeralDisks

withImageId

getImageId

setImageId

getLocalDiskSizeInGB

setLocalDiskSizeInGB

withLocalDiskSizeInGB

getCreateCdsList

setCreateCdsList

withCreateCdsList

getNetworkCapacityInMbps

setNetworkCapacityInMbps

withNetworkCapacityInMbps

getPurchaseCount

setPurchaseCount

withPurchaseCount

getName

setName

getHostname

setHostname

withHostname

isAutoSeqSuffix

setAutoSeqSuffix

withAutoSeqSuffix

withName

getAdminPass

setAdminPass

withAdminPass

getBilling

setBilling

withBilling

isRelationTag

setRelationTag

withRelationTag

getTags

setTags

withTags

withDedicatedHostId

getDedicatedHostId

setDedicatedHostId

withZoneName

getZoneName

setZoneName

withSubnetId

getSubnetId

setSubnetId

withSecurityGroupId

getSecurityGroupId

setSecurityGroupId