CreateImagePipelineRequest (ecs20140526 3.1.10 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.CreateImagePipelineRequest

public class CreateImagePipelineRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class CreateImagePipelineRequest.CreateImagePipelineRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`CreateImagePipelineRequest.CreateImagePipelineRequestTag`

字段概要

字段
限定符和类型	字段和说明
`List<Long>`	`addAccount` The IDs of Alibaba Cloud accounts with which you want to share the image that is created based on the image template.
`String`	`baseImage` The source image.
`String`	`baseImageType` The type of the source image.
`String`	`buildContent` The content of the image template.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`Boolean`	`deleteInstanceOnFailure` Specifies whether to release the intermediate instance if the image cannot be created.
`String`	`description` The description of the image template.
`String`	`imageName` The prefix of the image name.
`String`	`instanceType` The instance type.
`Integer`	`internetMaxBandwidthOut` The size of the outbound public bandwidth of the intermediate instance.
`String`	`name` The name of the image template.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`regionId` The region ID of the image template that you want to create.
`String`	`resourceGroupId` The ID of the resource group.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`Integer`	`systemDiskSize` The size of the system disk of the intermediate instance.
`List<CreateImagePipelineRequest.CreateImagePipelineRequestTag>`	`tag` The tags that you want to add to the image template.
`List<String>`	`toRegionId` The IDs of regions to which you want to distribute the image that is created based on the image template.
`String`	`vSwitchId` The ID of the vSwitch.

构造器概要

构造器
构造器和说明

CreateImagePipelineRequest()

构造器
构造器和说明
`CreateImagePipelineRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateImagePipelineRequest`	`build(Map<String,?> map)`
`List<Long>`	`getAddAccount()`
`String`	`getBaseImage()`
`String`	`getBaseImageType()`
`String`	`getBuildContent()`
`String`	`getClientToken()`
`Boolean`	`getDeleteInstanceOnFailure()`
`String`	`getDescription()`
`String`	`getImageName()`
`String`	`getInstanceType()`
`Integer`	`getInternetMaxBandwidthOut()`
`String`	`getName()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`Integer`	`getSystemDiskSize()`
`List<CreateImagePipelineRequest.CreateImagePipelineRequestTag>`	`getTag()`
`List<String>`	`getToRegionId()`
`String`	`getVSwitchId()`
`CreateImagePipelineRequest`	`setAddAccount(List<Long> addAccount)`
`CreateImagePipelineRequest`	`setBaseImage(String baseImage)`
`CreateImagePipelineRequest`	`setBaseImageType(String baseImageType)`
`CreateImagePipelineRequest`	`setBuildContent(String buildContent)`
`CreateImagePipelineRequest`	`setClientToken(String clientToken)`
`CreateImagePipelineRequest`	`setDeleteInstanceOnFailure(Boolean deleteInstanceOnFailure)`
`CreateImagePipelineRequest`	`setDescription(String description)`
`CreateImagePipelineRequest`	`setImageName(String imageName)`
`CreateImagePipelineRequest`	`setInstanceType(String instanceType)`
`CreateImagePipelineRequest`	`setInternetMaxBandwidthOut(Integer internetMaxBandwidthOut)`
`CreateImagePipelineRequest`	`setName(String name)`
`CreateImagePipelineRequest`	`setOwnerAccount(String ownerAccount)`
`CreateImagePipelineRequest`	`setOwnerId(Long ownerId)`
`CreateImagePipelineRequest`	`setRegionId(String regionId)`
`CreateImagePipelineRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateImagePipelineRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`CreateImagePipelineRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`CreateImagePipelineRequest`	`setSystemDiskSize(Integer systemDiskSize)`
`CreateImagePipelineRequest`	`setTag(List<CreateImagePipelineRequest.CreateImagePipelineRequestTag> tag)`
`CreateImagePipelineRequest`	`setToRegionId(List<String> toRegionId)`
`CreateImagePipelineRequest`	`setVSwitchId(String vSwitchId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - addAccount
```
@NameInMap(value="AddAccount")
public List<Long> addAccount
```
    The IDs of Alibaba Cloud accounts with which you want to share the image that is created based on the image template. You can specify up to 20 account IDs.
  - baseImage
```
@NameInMap(value="BaseImage")
public String baseImage
```
    The source image.
    
    * If you set the `BaseImageType` parameter to IMAGE, set the BaseImage parameter to the ID of a custom image.
    
    * If you set the `BaseImageType` parameter to IMAGE_FAMILY, set the BaseImage parameter to the name of an image family.
  - baseImageType
```
@NameInMap(value="BaseImageType")
public String baseImageType
```
    The type of the source image. Valid values:
    
    * IMAGE: image
    
    * IMAGE_FAMILY: image family
  - buildContent
```
@NameInMap(value="BuildContent")
public String buildContent
```
    The content of the image template. The content cannot exceed 16 KB in size and can contain up to 127 commands. For information about the commands that are supported by the image template, see the "Usage notes" section in this topic.
  - clientToken
```
@NameInMap(value="ClientToken")
public String clientToken
```
    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. **The token can contain only ASCII characters and cannot exceed 64 characters in length.** For more information, see [How to ensure idempotence](~~25693~~).
  - deleteInstanceOnFailure
```
@NameInMap(value="DeleteInstanceOnFailure")
public Boolean deleteInstanceOnFailure
```
    Specifies whether to release the intermediate instance if the image cannot be created. Valid values:
    
    * true: releases the intermediate instance if the image cannot be created.
    
    * false: does not release the intermediate instance if the image cannot be created.
    
    Default value: true.
    
    > If the intermediate instance cannot be started, the instance is automatically released.
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the image template. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.
  - imageName
```
@NameInMap(value="ImageName")
public String imageName
```
    The prefix of the image name. The prefix must be 2 to 64 characters in length. The prefix must start with a letter but cannot start with `http://` or `https://`. The prefix can contain letters, digits, colons (:), underscores (\_), periods (.), and hyphens (-).
    
    The system generates the final image name that consists of the specified prefix and the ID of the build task (`ExecutionId`) in the `{ImageName}_{ExecutionId}` format.
  - instanceType
```
@NameInMap(value="InstanceType")
public String instanceType
```
    The instance type. You can call the [DescribeInstanceTypes](~~25620~~) to query supported instance types.
    
    If you do not specify this parameter, an instance type that provides the fewest vCPUs and memory resources is selected. This configuration is subject to the resource availability of instance types. For example, the ecs.g6.large instance type is selected. If the available ecs.g6.large resources are insufficient, the ecs.g6.xlarge instance type is selected.
  - internetMaxBandwidthOut
```
@NameInMap(value="InternetMaxBandwidthOut")
public Integer internetMaxBandwidthOut
```
    The size of the outbound public bandwidth of the intermediate instance. Unit: Mbit/s. Valid values: 0 to 100.
    
    Default value: 0.
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the image template. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\_), periods (.), and hyphens (-).
    
    > If you do not specify the `Name` parameter, the value of the `ImagePipelineId` return parameter is used.
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the image template that you want to create. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group.
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - systemDiskSize
```
@NameInMap(value="SystemDiskSize")
public Integer systemDiskSize
```
    The size of the system disk of the intermediate instance. Unit: GiB. Valid values: 20 to 500.
    
    Default value: 40.
  - tag
```
@NameInMap(value="Tag")
public List<CreateImagePipelineRequest.CreateImagePipelineRequestTag> tag
```
    The tags that you want to add to the image template.
  - toRegionId
```
@NameInMap(value="ToRegionId")
public List<String> toRegionId
```
    The IDs of regions to which you want to distribute the image that is created based on the image template. You can specify up to 20 region IDs.
    
    If you do not specify this parameter, the image is created only in the current region.
  - vSwitchId
```
@NameInMap(value="VSwitchId")
public String vSwitchId
```
    The ID of the vSwitch.
    
    If you do not specify this parameter, a new virtual private cloud (VPC) and vSwitch are created by default. Make sure that the VPC quota of your account is sufficient. For more information, see [Limits](~~27750~~).
- 构造器详细资料
  - CreateImagePipelineRequest
```
public CreateImagePipelineRequest()
```
- 方法详细资料
  - build
```
public static CreateImagePipelineRequest build(Map<String,?> map)
                                        throws Exception
```
    抛出:
    
    Exception
  - setAddAccount
```
public CreateImagePipelineRequest setAddAccount(List<Long> addAccount)
```
  - getAddAccount
```
public List<Long> getAddAccount()
```
  - setBaseImage
```
public CreateImagePipelineRequest setBaseImage(String baseImage)
```
  - getBaseImage
```
public String getBaseImage()
```
  - setBaseImageType
```
public CreateImagePipelineRequest setBaseImageType(String baseImageType)
```
  - getBaseImageType
```
public String getBaseImageType()
```
  - setBuildContent
```
public CreateImagePipelineRequest setBuildContent(String buildContent)
```
  - getBuildContent
```
public String getBuildContent()
```
  - setClientToken
```
public CreateImagePipelineRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setDeleteInstanceOnFailure
```
public CreateImagePipelineRequest setDeleteInstanceOnFailure(Boolean deleteInstanceOnFailure)
```
  - getDeleteInstanceOnFailure
```
public Boolean getDeleteInstanceOnFailure()
```
  - setDescription
```
public CreateImagePipelineRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setImageName
```
public CreateImagePipelineRequest setImageName(String imageName)
```
  - getImageName
```
public String getImageName()
```
  - setInstanceType
```
public CreateImagePipelineRequest setInstanceType(String instanceType)
```
  - getInstanceType
```
public String getInstanceType()
```
  - setInternetMaxBandwidthOut
```
public CreateImagePipelineRequest setInternetMaxBandwidthOut(Integer internetMaxBandwidthOut)
```
  - getInternetMaxBandwidthOut
```
public Integer getInternetMaxBandwidthOut()
```
  - setName
```
public CreateImagePipelineRequest setName(String name)
```
  - getName
```
public String getName()
```
  - setOwnerAccount
```
public CreateImagePipelineRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public CreateImagePipelineRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public CreateImagePipelineRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public CreateImagePipelineRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public CreateImagePipelineRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public CreateImagePipelineRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setSystemDiskSize
```
public CreateImagePipelineRequest setSystemDiskSize(Integer systemDiskSize)
```
  - getSystemDiskSize
```
public Integer getSystemDiskSize()
```
  - setTag
```
public CreateImagePipelineRequest setTag(List<CreateImagePipelineRequest.CreateImagePipelineRequestTag> tag)
```
  - getTag
```
public List<CreateImagePipelineRequest.CreateImagePipelineRequestTag> getTag()
```
  - setToRegionId
```
public CreateImagePipelineRequest setToRegionId(List<String> toRegionId)
```
  - getToRegionId
```
public List<String> getToRegionId()
```
  - setVSwitchId
```
public CreateImagePipelineRequest setVSwitchId(String vSwitchId)
```
  - getVSwitchId
```
public String getVSwitchId()
```

类 CreateImagePipelineRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

addAccount

baseImage

baseImageType

buildContent

clientToken

deleteInstanceOnFailure

description

imageName

instanceType

internetMaxBandwidthOut

name

ownerAccount

ownerId

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

systemDiskSize

tag

toRegionId

vSwitchId

构造器详细资料

CreateImagePipelineRequest

方法详细资料

build

setAddAccount

getAddAccount

setBaseImage

getBaseImage

setBaseImageType

getBaseImageType

setBuildContent

getBuildContent

setClientToken

getClientToken

setDeleteInstanceOnFailure

getDeleteInstanceOnFailure

setDescription

getDescription

setImageName

getImageName

setInstanceType

getInstanceType

setInternetMaxBandwidthOut

getInternetMaxBandwidthOut

setName

getName

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setSystemDiskSize

getSystemDiskSize

setTag

getTag

setToRegionId

getToRegionId

setVSwitchId

getVSwitchId