CreateImagePipelineRequest (ecs20140526 5.4.5 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 to which to share the image that will be 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 when the image cannot be created.
`String`	`description` The description of the image template.
`String`	`imageFamily` This parameter is in invitational preview and is not publicly available.
`String`	`imageName` The prefix of the image name.
`String`	`instanceType` The instance type.
`Integer`	`internetMaxBandwidthOut` The size of the outbound public bandwidth for the intermediate instance.
`String`	`name` The name of the launch template.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`regionId` The ID of the region.
`String`	`repairMode` This parameter is in invitational preview and is not publicly available.
`String`	`resourceGroupId` The ID of the resource group.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`Integer`	`systemDiskSize` The system disk size of the intermediate instance.
`List<CreateImagePipelineRequest.CreateImagePipelineRequestTag>`	`tag` The tags to add to the template.
`String`	`testContent` This parameter is in invitational preview and is not publicly available.
`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`	`getImageFamily()`
`String`	`getImageName()`
`String`	`getInstanceType()`
`Integer`	`getInternetMaxBandwidthOut()`
`String`	`getName()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getRepairMode()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`Integer`	`getSystemDiskSize()`
`List<CreateImagePipelineRequest.CreateImagePipelineRequestTag>`	`getTag()`
`String`	`getTestContent()`
`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`	`setImageFamily(String imageFamily)`
`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`	`setRepairMode(String repairMode)`
`CreateImagePipelineRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateImagePipelineRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`CreateImagePipelineRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`CreateImagePipelineRequest`	`setSystemDiskSize(Integer systemDiskSize)`
`CreateImagePipelineRequest`	`setTag(List<CreateImagePipelineRequest.CreateImagePipelineRequestTag> tag)`
`CreateImagePipelineRequest`	`setTestContent(String testContent)`
`CreateImagePipelineRequest`	`setToRegionId(List<String> toRegionId)`
`CreateImagePipelineRequest`	`setVSwitchId(String vSwitchId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, 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 to which to share the image that will be created based on the image template. You can specify up to 20 account IDs.
    example:
    1234567890
  - baseImage
```
@NameInMap(value="BaseImage")
public String baseImage
```
    The source image.
    - If you set BaseImageType to IMAGE, set the BaseImage parameter to the ID of a custom image.
    - If you set BaseImageType to IMAGE_FAMILY, set the BaseImage parameter to the name of an image family.
    This parameter is required.
    example:
    m-bp67acfmxazb4p****
  - baseImageType
```
@NameInMap(value="BaseImageType")
public String baseImageType
```
    The type of the source image. Valid values:
    - IMAGE: image
    - IMAGE_FAMILY: image family
    This parameter is required.
    example:
    IMAGE
  - 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 more information about the commands that are supported, see the "Usage notes" section of this topic.
    example:
    FROM IMAGE:m-bp67acfmxazb4p****
  - 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.
    example:
    123e4567-e89b-12d3-a456-426655440000
  - deleteInstanceOnFailure
```
@NameInMap(value="DeleteInstanceOnFailure")
public Boolean deleteInstanceOnFailure
```
    Specifies whether to release the intermediate instance when the image cannot be created. Valid values:
    - true
    - false
    Default value: true.
    
    If the intermediate instance cannot be started, the instance is released by default.
    
    example:
    true
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the image template. The description must be 2 to 256 characters in length. It cannot start with http:// or https://.
    example:
    This is description.
  - imageFamily
```
@NameInMap(value="ImageFamily")
public String imageFamily
```
    This parameter is in invitational preview and is not publicly available.
    
    example:
    null
  - 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 and cannot start with http:// or https://. The prefix can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
    
    The system generates the final complete image name that consists of the specified prefix and the ID of the build task (ExecutionId) in the format of {ImageName}_{ExecutionId}.
    example:
    testImageName
  - instanceType
```
@NameInMap(value="InstanceType")
public String instanceType
```
    The instance type. You can call the DescribeInstanceTypes to query instance types.
    
    If you do not configure this parameter, an instance type that provides the fewest vCPUs and memory resources is automatically selected. This configuration is subject to resource availability of instance types. For example, the ecs.g6.large instance type is automatically selected. If available ecs.g6.large resources are insufficient, the ecs.g6.xlarge instance type is selected.
    example:
    ecs.g6.large
  - internetMaxBandwidthOut
```
@NameInMap(value="InternetMaxBandwidthOut")
public Integer internetMaxBandwidthOut
```
    The size of the outbound public bandwidth for the intermediate instance. Unit: Mbit/s. Valid values: 0 to 100.
    
    Default value: 0.
    example:
    0
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the launch 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 Name, the return value of ImagePipelineId is used.
    
    example:
    testImagePipeline
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The ID of the region. You can call the DescribeRegions operation to query the most recent region list.
    
    This parameter is required.
    example:
    cn-hangzhou
  - repairMode
```
@NameInMap(value="RepairMode")
public String repairMode
```
    This parameter is in invitational preview and is not publicly available.
    
    example:
    null
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group.
    example:
    rg-bp67acfmxazb4p****
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - systemDiskSize
```
@NameInMap(value="SystemDiskSize")
public Integer systemDiskSize
```
    The system disk size of the intermediate instance. Unit: GiB. Valid values: 20 to 500.
    
    Default value: 40.
    example:
    40
  - tag
```
@NameInMap(value="Tag")
public List<CreateImagePipelineRequest.CreateImagePipelineRequestTag> tag
```
    The tags to add to the template.
  - testContent
```
@NameInMap(value="TestContent")
public String testContent
```
    This parameter is in invitational preview and is not publicly available.
    
    example:
    null
  - 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.
    example:
    cn-hangzhou
  - vSwitchId
```
@NameInMap(value="VSwitchId")
public String vSwitchId
```
    The ID of the vSwitch.
    
    If you do not specify this parameter, a new VPC and vSwitch are created. Make sure that the VPC quota in your account is sufficient. For more information, see Limits and quotas.
    example:
    vsw-bp67acfmxazb4p****
- 构造器详细资料
  - 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()
```
  - setImageFamily
```
public CreateImagePipelineRequest setImageFamily(String imageFamily)
```
  - getImageFamily
```
public String getImageFamily()
```
  - 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()
```
  - setRepairMode
```
public CreateImagePipelineRequest setRepairMode(String repairMode)
```
  - getRepairMode
```
public String getRepairMode()
```
  - 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()
```
  - setTestContent
```
public CreateImagePipelineRequest setTestContent(String testContent)
```
  - getTestContent
```
public String getTestContent()
```
  - 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

imageFamily

imageName

instanceType

internetMaxBandwidthOut

name

ownerAccount

ownerId

regionId

repairMode

resourceGroupId

resourceOwnerAccount

resourceOwnerId

systemDiskSize

tag

testContent

toRegionId

vSwitchId

构造器详细资料

CreateImagePipelineRequest

方法详细资料

build

setAddAccount

getAddAccount

setBaseImage

getBaseImage

setBaseImageType

getBaseImageType

setBuildContent

getBuildContent

setClientToken

getClientToken

setDeleteInstanceOnFailure

getDeleteInstanceOnFailure

setDescription

getDescription

setImageFamily

getImageFamily

setImageName

getImageName

setInstanceType

getInstanceType

setInternetMaxBandwidthOut

getInternetMaxBandwidthOut

setName

getName

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setRegionId

getRegionId

setRepairMode

getRepairMode

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setSystemDiskSize

getSystemDiskSize

setTag

getTag

setTestContent

getTestContent