com.aliyun.sdk.service.ecs20140526.models.ImportImageRequest Maven / Gradle / Ivy
Show all versions of alibabacloud-ecs20140526 Show documentation
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sdk.service.ecs20140526.models;
import com.aliyun.sdk.gateway.pop.*;
import darabonba.core.*;
import darabonba.core.async.*;
import darabonba.core.sync.*;
import darabonba.core.client.*;
import darabonba.core.RequestModel;
import darabonba.core.TeaModel;
import com.aliyun.sdk.gateway.pop.models.*;
/**
*
* {@link ImportImageRequest} extends {@link RequestModel}
*
* ImportImageRequest
*/
public class ImportImageRequest extends Request {
@com.aliyun.core.annotation.Host
@com.aliyun.core.annotation.NameInMap("SourceRegionId")
private String sourceRegionId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Architecture")
private String architecture;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("BootMode")
private String bootMode;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ClientToken")
private String clientToken;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Description")
private String description;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("DetectionStrategy")
private String detectionStrategy;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("DiskDeviceMapping")
private java.util.List diskDeviceMapping;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("DryRun")
private Boolean dryRun;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Features")
private Features features;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ImageName")
private String imageName;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("LicenseType")
private String licenseType;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("OSType")
private String OSType;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("OwnerId")
private Long ownerId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Platform")
private String platform;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("RegionId")
@com.aliyun.core.annotation.Validation(required = true)
private String regionId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ResourceGroupId")
private String resourceGroupId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ResourceOwnerAccount")
private String resourceOwnerAccount;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ResourceOwnerId")
private Long resourceOwnerId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("RoleName")
private String roleName;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("StorageLocationArn")
private String storageLocationArn;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Tag")
private java.util.List tag;
private ImportImageRequest(Builder builder) {
super(builder);
this.sourceRegionId = builder.sourceRegionId;
this.architecture = builder.architecture;
this.bootMode = builder.bootMode;
this.clientToken = builder.clientToken;
this.description = builder.description;
this.detectionStrategy = builder.detectionStrategy;
this.diskDeviceMapping = builder.diskDeviceMapping;
this.dryRun = builder.dryRun;
this.features = builder.features;
this.imageName = builder.imageName;
this.licenseType = builder.licenseType;
this.OSType = builder.OSType;
this.ownerId = builder.ownerId;
this.platform = builder.platform;
this.regionId = builder.regionId;
this.resourceGroupId = builder.resourceGroupId;
this.resourceOwnerAccount = builder.resourceOwnerAccount;
this.resourceOwnerId = builder.resourceOwnerId;
this.roleName = builder.roleName;
this.storageLocationArn = builder.storageLocationArn;
this.tag = builder.tag;
}
public static Builder builder() {
return new Builder();
}
public static ImportImageRequest create() {
return builder().build();
}
@Override
public Builder toBuilder() {
return new Builder(this);
}
/**
* @return sourceRegionId
*/
public String getSourceRegionId() {
return this.sourceRegionId;
}
/**
* @return architecture
*/
public String getArchitecture() {
return this.architecture;
}
/**
* @return bootMode
*/
public String getBootMode() {
return this.bootMode;
}
/**
* @return clientToken
*/
public String getClientToken() {
return this.clientToken;
}
/**
* @return description
*/
public String getDescription() {
return this.description;
}
/**
* @return detectionStrategy
*/
public String getDetectionStrategy() {
return this.detectionStrategy;
}
/**
* @return diskDeviceMapping
*/
public java.util.List getDiskDeviceMapping() {
return this.diskDeviceMapping;
}
/**
* @return dryRun
*/
public Boolean getDryRun() {
return this.dryRun;
}
/**
* @return features
*/
public Features getFeatures() {
return this.features;
}
/**
* @return imageName
*/
public String getImageName() {
return this.imageName;
}
/**
* @return licenseType
*/
public String getLicenseType() {
return this.licenseType;
}
/**
* @return OSType
*/
public String getOSType() {
return this.OSType;
}
/**
* @return ownerId
*/
public Long getOwnerId() {
return this.ownerId;
}
/**
* @return platform
*/
public String getPlatform() {
return this.platform;
}
/**
* @return regionId
*/
public String getRegionId() {
return this.regionId;
}
/**
* @return resourceGroupId
*/
public String getResourceGroupId() {
return this.resourceGroupId;
}
/**
* @return resourceOwnerAccount
*/
public String getResourceOwnerAccount() {
return this.resourceOwnerAccount;
}
/**
* @return resourceOwnerId
*/
public Long getResourceOwnerId() {
return this.resourceOwnerId;
}
/**
* @return roleName
*/
public String getRoleName() {
return this.roleName;
}
/**
* @return storageLocationArn
*/
public String getStorageLocationArn() {
return this.storageLocationArn;
}
/**
* @return tag
*/
public java.util.List getTag() {
return this.tag;
}
public static final class Builder extends Request.Builder {
private String sourceRegionId;
private String architecture;
private String bootMode;
private String clientToken;
private String description;
private String detectionStrategy;
private java.util.List diskDeviceMapping;
private Boolean dryRun;
private Features features;
private String imageName;
private String licenseType;
private String OSType;
private Long ownerId;
private String platform;
private String regionId;
private String resourceGroupId;
private String resourceOwnerAccount;
private Long resourceOwnerId;
private String roleName;
private String storageLocationArn;
private java.util.List tag;
private Builder() {
super();
}
private Builder(ImportImageRequest request) {
super(request);
this.sourceRegionId = request.sourceRegionId;
this.architecture = request.architecture;
this.bootMode = request.bootMode;
this.clientToken = request.clientToken;
this.description = request.description;
this.detectionStrategy = request.detectionStrategy;
this.diskDeviceMapping = request.diskDeviceMapping;
this.dryRun = request.dryRun;
this.features = request.features;
this.imageName = request.imageName;
this.licenseType = request.licenseType;
this.OSType = request.OSType;
this.ownerId = request.ownerId;
this.platform = request.platform;
this.regionId = request.regionId;
this.resourceGroupId = request.resourceGroupId;
this.resourceOwnerAccount = request.resourceOwnerAccount;
this.resourceOwnerId = request.resourceOwnerId;
this.roleName = request.roleName;
this.storageLocationArn = request.storageLocationArn;
this.tag = request.tag;
}
/**
* SourceRegionId.
*/
public Builder sourceRegionId(String sourceRegionId) {
this.putHostParameter("SourceRegionId", sourceRegionId);
this.sourceRegionId = sourceRegionId;
return this;
}
/**
* The system architecture. Valid values:
*
* - i386
* - x86_64
* - arm64
*
* Default value: x86_64.
*
* example:
* x86_64
*/
public Builder architecture(String architecture) {
this.putQueryParameter("Architecture", architecture);
this.architecture = architecture;
return this;
}
/**
* The boot mode of the image. Valid values:
*
* - BIOS
* - UEFI
*
* Default value: BIOS. If you set Architecture to arm64, set this parameter to UEFI.
*
* Make sure that you are aware of the boot modes supported by the specified image, as thehe modified boot mode needs to be supported by the image. This way, instances that use this image can start.
*
*
* example:
* BIOS
*/
public Builder bootMode(String bootMode) {
this.putQueryParameter("BootMode", bootMode);
this.bootMode = bootMode;
return this;
}
/**
* ClientToken.
*/
public Builder clientToken(String clientToken) {
this.putQueryParameter("ClientToken", clientToken);
this.clientToken = clientToken;
return this;
}
/**
* The image description. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
*
* example:
* TestDescription
*/
public Builder description(String description) {
this.putQueryParameter("Description", description);
this.description = description;
return this;
}
/**
* The mode in which to check the image. If you do not specify this parameter, the image is not checked. Only the standard check mode is supported.
*
* This parameter is supported for most Linux and Windows operating system versions. For more information about image check items and operating system limits for image check, see Overview and Operating system limits for image check.
*
*
* example:
* Standard
*/
public Builder detectionStrategy(String detectionStrategy) {
this.putQueryParameter("DetectionStrategy", detectionStrategy);
this.detectionStrategy = detectionStrategy;
return this;
}
/**
* The information of disks from which the custom images are created.
*/
public Builder diskDeviceMapping(java.util.List diskDeviceMapping) {
this.putQueryParameter("DiskDeviceMapping", diskDeviceMapping);
this.diskDeviceMapping = diskDeviceMapping;
return this;
}
/**
* Specifies whether to perform only a dry run, without performing the actual request. Valid values:
*
* - true: performs only a dry run. The system checks the request for potential issues, including invalid AccessKey pairs, unauthorized RAM users, and missing parameter values. If the request fails the dry run, an error message is returned. If the request passes the dry run, the
DryRunOperation error code is returned.
* - false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
*
* Default value: false.
*
* example:
* false
*/
public Builder dryRun(Boolean dryRun) {
this.putQueryParameter("DryRun", dryRun);
this.dryRun = dryRun;
return this;
}
/**
* The attributes of the custom image.
*/
public Builder features(Features features) {
this.putQueryParameter("Features", features);
this.features = features;
return this;
}
/**
* The image name. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with acs: or aliyun. The name cannot contain http:// or https://. The name can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-).
*
* example:
* ImageTestName
*/
public Builder imageName(String imageName) {
this.putQueryParameter("ImageName", imageName);
this.imageName = imageName;
return this;
}
/**
* The type of the license used to activate the operating system after the image is imported. Valid values:
*
* - Auto: ECS checks the operating system of the image and allocates a license to the operating system. ECS first checks whether the operating system distribution specified by
Platform has a license allocated through an official Alibaba Cloud channel. If yes, the allocated license is used. If no, the license that comes with the source operating system is used.
* - Aliyun: The license allocated through an official Alibaba Cloud channel is used for the operating system distribution specified by
Platform.
* - BYOL: The license that comes with the source operating system is used. In this case, make sure that your license key is eligible for use in Alibaba Cloud.
*
* Default value: Auto.
*
* example:
* Auto
*/
public Builder licenseType(String licenseType) {
this.putQueryParameter("LicenseType", licenseType);
this.licenseType = licenseType;
return this;
}
/**
* The operating system platform. Valid values:
*
* - windows
* - linux
*
* Default value: linux.
*
* example:
* linux
*/
public Builder OSType(String OSType) {
this.putQueryParameter("OSType", OSType);
this.OSType = OSType;
return this;
}
/**
* OwnerId.
*/
public Builder ownerId(Long ownerId) {
this.putQueryParameter("OwnerId", ownerId);
this.ownerId = ownerId;
return this;
}
/**
* The operating system distribution. Valid values:
*
* - Aliyun
* - Anolis
* - CentOS
* - Ubuntu
* - CoreOS
* - SUSE
* - Debian
* - OpenSUSE
* - FreeBSD
* - RedHat
* - Kylin
* - UOS
* - Fedora
* - Fedora CoreOS
* - CentOS Stream
* - AlmaLinux
* - Rocky Linux
* - Gentoo
* - Customized Linux
* - Others Linux
* - Windows Server 2022
* - Windows Server 2019
* - Windows Server 2016
* - Windows Server 2012
* - Windows Server 2008
* - Windows Server 2003
*
* Default value: Others Linux.
*
* example:
* Aliyun
*/
public Builder platform(String platform) {
this.putQueryParameter("Platform", platform);
this.platform = platform;
return this;
}
/**
* The region ID of the source image. You can call the DescribeRegions operation to query the most recent region list.
* This parameter is required.
*
* example:
* cn-hangzhou
*/
public Builder regionId(String regionId) {
this.putQueryParameter("RegionId", regionId);
this.regionId = regionId;
return this;
}
/**
* The ID of the resource group to which to assign the image.
*
* example:
* rg-bp67acfmxazb4p****
*/
public Builder resourceGroupId(String resourceGroupId) {
this.putQueryParameter("ResourceGroupId", resourceGroupId);
this.resourceGroupId = resourceGroupId;
return this;
}
/**
* ResourceOwnerAccount.
*/
public Builder resourceOwnerAccount(String resourceOwnerAccount) {
this.putQueryParameter("ResourceOwnerAccount", resourceOwnerAccount);
this.resourceOwnerAccount = resourceOwnerAccount;
return this;
}
/**
* ResourceOwnerId.
*/
public Builder resourceOwnerId(Long resourceOwnerId) {
this.putQueryParameter("ResourceOwnerId", resourceOwnerId);
this.resourceOwnerId = resourceOwnerId;
return this;
}
/**
* The name of the RAM role used to import the image.
*
* example:
* AliyunECSImageImportDefaultRole
*/
public Builder roleName(String roleName) {
this.putQueryParameter("RoleName", roleName);
this.roleName = roleName;
return this;
}
/**
* The Alibaba Cloud Resource Name (ARN) of the cloud box, which is used to uniquely identify a storage location in the cloud.
*
* Specify this parameter only if you import an image from OSS on CloudBox. Otherwise, you do not need to specify this parameter. For more information, see What is OSS on CloudBox?
*
* The ARN must be in the following format: arn:acs:cloudbox:{RegionId}:{AliUid}:cloudbox/{CloudBoxId}. Replace {RegionId} with the region ID of the cloud box, {AliUid} with the ID of the Alibaba Cloud account to which the cloud box belongs, and {CloudBoxId} with the ID of the cloud box.
*
* example:
* arn:acs:cloudbox:cn-hangzhou:123456:cloudbox/cb-xx***123
*/
public Builder storageLocationArn(String storageLocationArn) {
this.putQueryParameter("StorageLocationArn", storageLocationArn);
this.storageLocationArn = storageLocationArn;
return this;
}
/**
* The image tags.
*/
public Builder tag(java.util.List tag) {
this.putQueryParameter("Tag", tag);
this.tag = tag;
return this;
}
@Override
public ImportImageRequest build() {
return new ImportImageRequest(this);
}
}
/**
*
* {@link ImportImageRequest} extends {@link TeaModel}
*
* ImportImageRequest
*/
public static class DiskDeviceMapping extends TeaModel {
@com.aliyun.core.annotation.NameInMap("Device")
private String device;
@com.aliyun.core.annotation.NameInMap("DiskImSize")
private Integer diskImSize;
@com.aliyun.core.annotation.NameInMap("DiskImageSize")
private Integer diskImageSize;
@com.aliyun.core.annotation.NameInMap("Format")
private String format;
@com.aliyun.core.annotation.NameInMap("OSSBucket")
private String OSSBucket;
@com.aliyun.core.annotation.NameInMap("OSSObject")
private String OSSObject;
private DiskDeviceMapping(Builder builder) {
this.device = builder.device;
this.diskImSize = builder.diskImSize;
this.diskImageSize = builder.diskImageSize;
this.format = builder.format;
this.OSSBucket = builder.OSSBucket;
this.OSSObject = builder.OSSObject;
}
public static Builder builder() {
return new Builder();
}
public static DiskDeviceMapping create() {
return builder().build();
}
/**
* @return device
*/
public String getDevice() {
return this.device;
}
/**
* @return diskImSize
*/
public Integer getDiskImSize() {
return this.diskImSize;
}
/**
* @return diskImageSize
*/
public Integer getDiskImageSize() {
return this.diskImageSize;
}
/**
* @return format
*/
public String getFormat() {
return this.format;
}
/**
* @return OSSBucket
*/
public String getOSSBucket() {
return this.OSSBucket;
}
/**
* @return OSSObject
*/
public String getOSSObject() {
return this.OSSObject;
}
public static final class Builder {
private String device;
private Integer diskImSize;
private Integer diskImageSize;
private String format;
private String OSSBucket;
private String OSSObject;
/**
* The device name of disk N in the custom image.
*
* This parameter will be removed in the future. We recommend that you do not use this parameter to ensure future compatibility.
*
*
* example:
* null
*/
public Builder device(String device) {
this.device = device;
return this;
}
/**
* The size of disk N in the custom image. Unit: GiB.
* You can use this parameter to specify the sizes of the system disk and data disks in the custom image. When you specify the size of the system disk, make sure that the specified size is greater than or equal to the size of the imported image file. Unit: GiB. Valid values:
*
* - When the N value is 1, this parameter specifies the size of the system disk in the custom image. Valid values: 1 to 2048.
* - When the N value is an integer in the range of 2 to 17, this parameter specifies the size of a data disk in the custom image. Valid values: 1 to 2048.
*
* After the image file is uploaded to an OSS bucket, you can view the size of the image file in the OSS bucket.
*
* This parameter will be removed in the future. We recommend that you use DiskDeviceMapping.N.DiskImageSize to ensure future compatibility.
*
*
* example:
* 80
*/
public Builder diskImSize(Integer diskImSize) {
this.diskImSize = diskImSize;
return this;
}
/**
* The size of disk N in the custom image after the image is imported.
* You can use this parameter to specify the sizes of the system disk and data disks in the custom image. When you specify the size of the system disk, make sure that the specified size is greater than or equal to the size of the imported image file. Unit: GiB. Valid values:
*
* - When the N value is 1, this parameter specifies the size of the system disk in the custom image. Valid values: 1 to 2048.
* - When the N value is an integer in the range of 2 to 17, this parameter specifies the size of a data disk in the custom image. Valid values: 1 to 2048.
*
* After the image file is uploaded to an OSS bucket, you can view the size of the image file in the OSS bucket.
*
* example:
* 80
*/
public Builder diskImageSize(Integer diskImageSize) {
this.diskImageSize = diskImageSize;
return this;
}
/**
* The image format. Valid values:
*
* - RAW
* - VHD
* - QCOW2
*
* This parameter is empty by default, which indicates that the system checks the format of the image and uses the check result as the value of this parameter.
*
* example:
* QCOW2
*/
public Builder format(String format) {
this.format = format;
return this;
}
/**
* The OSS bucket where the image file is stored.
*
* Before you import images for the first time, you must use RAM to authorize ECS to access your OSS buckets. If ECS is not authorized to access your OSS buckets, the NoSetRoletoECSServiceAcount error code is returned when you call the ImportImage operation. For more information, see the "Usage notes" section in this topic.
*
*
* example:
* ecsimageos
*/
public Builder OSSBucket(String OSSBucket) {
this.OSSBucket = OSSBucket;
return this;
}
/**
* The name (key) of the object that the uploaded image is stored as in the OSS bucket.
*
* example:
* CentOS_5.4_32.raw
*/
public Builder OSSObject(String OSSObject) {
this.OSSObject = OSSObject;
return this;
}
public DiskDeviceMapping build() {
return new DiskDeviceMapping(this);
}
}
}
/**
*
* {@link ImportImageRequest} extends {@link TeaModel}
*
* ImportImageRequest
*/
public static class Features extends TeaModel {
@com.aliyun.core.annotation.NameInMap("ImdsSupport")
private String imdsSupport;
@com.aliyun.core.annotation.NameInMap("NvmeSupport")
private String nvmeSupport;
private Features(Builder builder) {
this.imdsSupport = builder.imdsSupport;
this.nvmeSupport = builder.nvmeSupport;
}
public static Builder builder() {
return new Builder();
}
public static Features create() {
return builder().build();
}
/**
* @return imdsSupport
*/
public String getImdsSupport() {
return this.imdsSupport;
}
/**
* @return nvmeSupport
*/
public String getNvmeSupport() {
return this.nvmeSupport;
}
public static final class Builder {
private String imdsSupport;
private String nvmeSupport;
/**
* ImdsSupport.
*/
public Builder imdsSupport(String imdsSupport) {
this.imdsSupport = imdsSupport;
return this;
}
/**
* Specifies whether the image supports the Non-Volatile Memory Express (NVMe) protocol. Valid values:
*
* - supported: The image supports the NVMe protocol. Instances created from the image also support the NVMe protocol.
* - unsupported: The image does not support the NVMe protocol. Instances created from the image do not support the NVMe protocol.
*
*
* example:
* supported
*/
public Builder nvmeSupport(String nvmeSupport) {
this.nvmeSupport = nvmeSupport;
return this;
}
public Features build() {
return new Features(this);
}
}
}
/**
*
* {@link ImportImageRequest} extends {@link TeaModel}
*
* ImportImageRequest
*/
public static class Tag extends TeaModel {
@com.aliyun.core.annotation.NameInMap("Key")
private String key;
@com.aliyun.core.annotation.NameInMap("Value")
private String value;
private Tag(Builder builder) {
this.key = builder.key;
this.value = builder.value;
}
public static Builder builder() {
return new Builder();
}
public static Tag create() {
return builder().build();
}
/**
* @return key
*/
public String getKey() {
return this.key;
}
/**
* @return value
*/
public String getValue() {
return this.value;
}
public static final class Builder {
private String key;
private String value;
/**
* The key of tag N of the image. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.
*
* example:
* TestKey
*/
public Builder key(String key) {
this.key = key;
return this;
}
/**
* The value of tag N of the image. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs:.
*
* example:
* TestValue
*/
public Builder value(String value) {
this.value = value;
return this;
}
public Tag build() {
return new Tag(this);
}
}
}
}