com.jdcloud.sdk.service.vm.model.InstanceDiskAttachmentSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vm Show documentation
JDCLOUD Open API SDK for Java
The newest version!
/*
 * Copyright 2018 JDCLOUD.COM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http:#www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * 
 * 
 *
 * 
 * Contact: 
 *
 * NOTE: This class is auto generated by the jdcloud code generator program.
 */

package com.jdcloud.sdk.service.vm.model;

import com.jdcloud.sdk.service.disk.model.DiskSpec;

/**
 * 云主机实例磁盘挂载点配置信息。
 */
public class InstanceDiskAttachmentSpec  implements java.io.Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 磁盘类型。
**系统盘**：此参数无须指定，其类型取决于镜像类型。
**数据盘**：可选值：`cloud`：云硬盘，数据盘仅支持云硬盘。

     */
    private String diskCategory;

    /**
     * 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
`true`：随实例删除。
`false`（默认值）：不随实例删除。

     */
    private Boolean autoDelete;

    /**
     * 磁盘详细配置。此参数仅针对云硬盘，本地系统盘无须指定且指定无效。

     */
    private DiskSpec cloudDiskSpec;

    /**
     * 磁盘逻辑挂载点。
**系统盘**：此参数无须指定且指定无效，默认为vda。
**数据盘**：取值范围：`[vdb~vdbm]`。

     */
    private String deviceName;

    /**
     * 排除设备，使用此参数 `noDevice` 配合 `deviceName` 一起使用。
创建镜像的场景下：使用此参数可以排除云主机实例中的云硬盘不参与制作快照。
创建实例模板的场景下：使用此参数可以排除镜像中的数据盘。
创建云主机的场景下：使用此参数可以排除实例模板、或镜像中的数据盘。
示例：如果镜像中除系统盘还包含一块或多块数据盘，期望仅使用镜像中的部分磁盘，可通过此参数忽略部分磁盘配置。此参数须配合 `deviceName` 一起使用。
例：`deviceName=vdb`、`noDevice=true`，则表示在使用镜像创建实例时，忽略数据盘vdb配置，不创建磁盘。
     */
    private Boolean noDevice;



    /**
     * get 磁盘类型。
**系统盘**：此参数无须指定，其类型取决于镜像类型。
**数据盘**：可选值：`cloud`：云硬盘，数据盘仅支持云硬盘。

     *
     * @return
     */
    public String getDiskCategory() {
        return diskCategory;
    }

    /**
     * set 磁盘类型。
**系统盘**：此参数无须指定，其类型取决于镜像类型。
**数据盘**：可选值：`cloud`：云硬盘，数据盘仅支持云硬盘。

     *
     * @param diskCategory
     */
    public void setDiskCategory(String diskCategory) {
        this.diskCategory = diskCategory;
    }


    /**
     * get 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
`true`：随实例删除。
`false`（默认值）：不随实例删除。

     *
     * @return
     */
    public Boolean getAutoDelete() {
        return autoDelete;
    }

    /**
     * set 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
`true`：随实例删除。
`false`（默认值）：不随实例删除。

     *
     * @param autoDelete
     */
    public void setAutoDelete(Boolean autoDelete) {
        this.autoDelete = autoDelete;
    }


    /**
     * get 磁盘详细配置。此参数仅针对云硬盘，本地系统盘无须指定且指定无效。

     *
     * @return
     */
    public DiskSpec getCloudDiskSpec() {
        return cloudDiskSpec;
    }

    /**
     * set 磁盘详细配置。此参数仅针对云硬盘，本地系统盘无须指定且指定无效。

     *
     * @param cloudDiskSpec
     */
    public void setCloudDiskSpec(DiskSpec cloudDiskSpec) {
        this.cloudDiskSpec = cloudDiskSpec;
    }


    /**
     * get 磁盘逻辑挂载点。
**系统盘**：此参数无须指定且指定无效，默认为vda。
**数据盘**：取值范围：`[vdb~vdbm]`。

     *
     * @return
     */
    public String getDeviceName() {
        return deviceName;
    }

    /**
     * set 磁盘逻辑挂载点。
**系统盘**：此参数无须指定且指定无效，默认为vda。
**数据盘**：取值范围：`[vdb~vdbm]`。

     *
     * @param deviceName
     */
    public void setDeviceName(String deviceName) {
        this.deviceName = deviceName;
    }


    /**
     * get 排除设备，使用此参数 `noDevice` 配合 `deviceName` 一起使用。
创建镜像的场景下：使用此参数可以排除云主机实例中的云硬盘不参与制作快照。
创建实例模板的场景下：使用此参数可以排除镜像中的数据盘。
创建云主机的场景下：使用此参数可以排除实例模板、或镜像中的数据盘。
示例：如果镜像中除系统盘还包含一块或多块数据盘，期望仅使用镜像中的部分磁盘，可通过此参数忽略部分磁盘配置。此参数须配合 `deviceName` 一起使用。
例：`deviceName=vdb`、`noDevice=true`，则表示在使用镜像创建实例时，忽略数据盘vdb配置，不创建磁盘。
     *
     * @return
     */
    public Boolean getNoDevice() {
        return noDevice;
    }

    /**
     * set 排除设备，使用此参数 `noDevice` 配合 `deviceName` 一起使用。
创建镜像的场景下：使用此参数可以排除云主机实例中的云硬盘不参与制作快照。
创建实例模板的场景下：使用此参数可以排除镜像中的数据盘。
创建云主机的场景下：使用此参数可以排除实例模板、或镜像中的数据盘。
示例：如果镜像中除系统盘还包含一块或多块数据盘，期望仅使用镜像中的部分磁盘，可通过此参数忽略部分磁盘配置。此参数须配合 `deviceName` 一起使用。
例：`deviceName=vdb`、`noDevice=true`，则表示在使用镜像创建实例时，忽略数据盘vdb配置，不创建磁盘。
     *
     * @param noDevice
     */
    public void setNoDevice(Boolean noDevice) {
        this.noDevice = noDevice;
    }



    /**
     * set 磁盘类型。
**系统盘**：此参数无须指定，其类型取决于镜像类型。
**数据盘**：可选值：`cloud`：云硬盘，数据盘仅支持云硬盘。

     *
     * @param diskCategory
     */
    public InstanceDiskAttachmentSpec diskCategory(String diskCategory) {
        this.diskCategory = diskCategory;
        return this;
    }


    /**
     * set 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
`true`：随实例删除。
`false`（默认值）：不随实例删除。

     *
     * @param autoDelete
     */
    public InstanceDiskAttachmentSpec autoDelete(Boolean autoDelete) {
        this.autoDelete = autoDelete;
        return this;
    }


    /**
     * set 磁盘详细配置。此参数仅针对云硬盘，本地系统盘无须指定且指定无效。

     *
     * @param cloudDiskSpec
     */
    public InstanceDiskAttachmentSpec cloudDiskSpec(DiskSpec cloudDiskSpec) {
        this.cloudDiskSpec = cloudDiskSpec;
        return this;
    }


    /**
     * set 磁盘逻辑挂载点。
**系统盘**：此参数无须指定且指定无效，默认为vda。
**数据盘**：取值范围：`[vdb~vdbm]`。

     *
     * @param deviceName
     */
    public InstanceDiskAttachmentSpec deviceName(String deviceName) {
        this.deviceName = deviceName;
        return this;
    }


    /**
     * set 排除设备，使用此参数 `noDevice` 配合 `deviceName` 一起使用。
创建镜像的场景下：使用此参数可以排除云主机实例中的云硬盘不参与制作快照。
创建实例模板的场景下：使用此参数可以排除镜像中的数据盘。
创建云主机的场景下：使用此参数可以排除实例模板、或镜像中的数据盘。
示例：如果镜像中除系统盘还包含一块或多块数据盘，期望仅使用镜像中的部分磁盘，可通过此参数忽略部分磁盘配置。此参数须配合 `deviceName` 一起使用。
例：`deviceName=vdb`、`noDevice=true`，则表示在使用镜像创建实例时，忽略数据盘vdb配置，不创建磁盘。
     *
     * @param noDevice
     */
    public InstanceDiskAttachmentSpec noDevice(Boolean noDevice) {
        this.noDevice = noDevice;
        return this;
    }


}