com.softlayer.api.service.virtual.guest.block.Device Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.virtual.guest.block;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.virtual.Guest;
import com.softlayer.api.service.virtual.disk.Image;
import com.softlayer.api.service.virtual.guest.block.device.Status;
import java.util.GregorianCalendar;

/**
 * The block device data type presents the structure in which all block devices will be presented. A block device attaches a disk image to a guest. Internally, the structure supports various virtualization platforms with no change to external interaction. 

 * 

 * A guest, also known as a virtual server, represents an allocation of resources on a virtual host. 
 *
 * @see SoftLayer_Virtual_Guest_Block_Device
 */
@ApiType("SoftLayer_Virtual_Guest_Block_Device")
public class Device extends Entity {

    /**
     * The disk image that a block device connects to in a computing instance.
     */
    @ApiProperty
    protected Image diskImage;

    public Image getDiskImage() {
        return diskImage;
    }

    public void setDiskImage(Image diskImage) {
        this.diskImage = diskImage;
    }

    /**
     * The computing instance that this block device is attached to.
     */
    @ApiProperty
    protected Guest guest;

    public Guest getGuest() {
        return guest;
    }

    public void setGuest(Guest guest) {
        this.guest = guest;
    }

    @ApiProperty
    protected Status status;

    public Status getStatus() {
        return status;
    }

    public void setStatus(Status status) {
        this.status = status;
    }

    /**
     * A flag indicating if a block device can be booted from. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long bootableFlag;

    public Long getBootableFlag() {
        return bootableFlag;
    }

    public void setBootableFlag(Long bootableFlag) {
        bootableFlagSpecified = true;
        this.bootableFlag = bootableFlag;
    }

    protected boolean bootableFlagSpecified;

    public boolean isBootableFlagSpecified() {
        return bootableFlagSpecified;
    }

    public void unsetBootableFlag() {
        bootableFlag = null;
        bootableFlagSpecified = false;
    }

    /**
     * The date a block device was created. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * A name used to identify a block device. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String device;

    public String getDevice() {
        return device;
    }

    public void setDevice(String device) {
        deviceSpecified = true;
        this.device = device;
    }

    protected boolean deviceSpecified;

    public boolean isDeviceSpecified() {
        return deviceSpecified;
    }

    public void unsetDevice() {
        device = null;
        deviceSpecified = false;
    }

    /**
     * A block device [[SoftLayer_Virtual_Disk_Image|disk image]]'s unique ID. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long diskImageId;

    public Long getDiskImageId() {
        return diskImageId;
    }

    public void setDiskImageId(Long diskImageId) {
        diskImageIdSpecified = true;
        this.diskImageId = diskImageId;
    }

    protected boolean diskImageIdSpecified;

    public boolean isDiskImageIdSpecified() {
        return diskImageIdSpecified;
    }

    public void unsetDiskImageId() {
        diskImageId = null;
        diskImageIdSpecified = false;
    }

    /**
     * The [[SoftLayer_Virtual_Guest|computing instance]] that a block device is associated with. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long guestId;

    public Long getGuestId() {
        return guestId;
    }

    public void setGuestId(Long guestId) {
        guestIdSpecified = true;
        this.guestId = guestId;
    }

    protected boolean guestIdSpecified;

    public boolean isGuestIdSpecified() {
        return guestIdSpecified;
    }

    public void unsetGuestId() {
        guestId = null;
        guestIdSpecified = false;
    }

    /**
     * A flag indicating if a block device can be plugged into a computing instance without having to shut down the instance. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hotPlugFlag;

    public Long getHotPlugFlag() {
        return hotPlugFlag;
    }

    public void setHotPlugFlag(Long hotPlugFlag) {
        hotPlugFlagSpecified = true;
        this.hotPlugFlag = hotPlugFlag;
    }

    protected boolean hotPlugFlagSpecified;

    public boolean isHotPlugFlagSpecified() {
        return hotPlugFlagSpecified;
    }

    public void unsetHotPlugFlag() {
        hotPlugFlag = null;
        hotPlugFlagSpecified = false;
    }

    /**
     * A computing instance block device's unique ID. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The data a block device was last modified. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * The writing mode that a virtual block device is mounted as, either "RO" for read-only mode or "RW" for read and write mode. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String mountMode;

    public String getMountMode() {
        return mountMode;
    }

    public void setMountMode(String mountMode) {
        mountModeSpecified = true;
        this.mountMode = mountMode;
    }

    protected boolean mountModeSpecified;

    public boolean isMountModeSpecified() {
        return mountModeSpecified;
    }

    public void unsetMountMode() {
        mountMode = null;
        mountModeSpecified = false;
    }

    /**
     * The type of device that a virtual block device is mounted as, either "Disk" for a directly connected storage disk or "CD" for devices that are mounted as optical drives.. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String mountType;

    public String getMountType() {
        return mountType;
    }

    public void setMountType(String mountType) {
        mountTypeSpecified = true;
        this.mountType = mountType;
    }

    protected boolean mountTypeSpecified;

    public boolean isMountTypeSpecified() {
        return mountTypeSpecified;
    }

    public void unsetMountType() {
        mountType = null;
        mountTypeSpecified = false;
    }

    /**
     * The status of the device, either disconnected or connected 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long statusId;

    public Long getStatusId() {
        return statusId;
    }

    public void setStatusId(Long statusId) {
        statusIdSpecified = true;
        this.statusId = statusId;
    }

    protected boolean statusIdSpecified;

    public boolean isStatusIdSpecified() {
        return statusIdSpecified;
    }

    public void unsetStatusId() {
        statusId = null;
        statusIdSpecified = false;
    }

    /**
     * A block device's unique ID on a virtualization platform. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String uuid;

    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        uuidSpecified = true;
        this.uuid = uuid;
    }

    protected boolean uuidSpecified;

    public boolean isUuidSpecified() {
        return uuidSpecified;
    }

    public void unsetUuid() {
        uuid = null;
        uuidSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.virtual.disk.Image.Mask diskImage() {
            return withSubMask("diskImage", com.softlayer.api.service.virtual.disk.Image.Mask.class);
        }

        public com.softlayer.api.service.virtual.Guest.Mask guest() {
            return withSubMask("guest", com.softlayer.api.service.virtual.Guest.Mask.class);
        }

        public com.softlayer.api.service.virtual.guest.block.device.Status.Mask status() {
            return withSubMask("status", com.softlayer.api.service.virtual.guest.block.device.Status.Mask.class);
        }

        public Mask bootableFlag() {
            withLocalProperty("bootableFlag");
            return this;
        }

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask device() {
            withLocalProperty("device");
            return this;
        }

        public Mask diskImageId() {
            withLocalProperty("diskImageId");
            return this;
        }

        public Mask guestId() {
            withLocalProperty("guestId");
            return this;
        }

        public Mask hotPlugFlag() {
            withLocalProperty("hotPlugFlag");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask modifyDate() {
            withLocalProperty("modifyDate");
            return this;
        }

        public Mask mountMode() {
            withLocalProperty("mountMode");
            return this;
        }

        public Mask mountType() {
            withLocalProperty("mountType");
            return this;
        }

        public Mask statusId() {
            withLocalProperty("statusId");
            return this;
        }

        public Mask uuid() {
            withLocalProperty("uuid");
            return this;
        }

    }

}