com.softlayer.api.service.virtual.guest.block.device.Template 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.device;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.virtual.disk.Image;
import com.softlayer.api.service.virtual.guest.block.device.template.Group;
import java.math.BigDecimal;

/**
 * The virtual block device template data type presents the structure in which all archived image templates are presented. 

 * 

 * A virtual block device template, also known as a image template, represents the image of a virtual guest instance. 
 *
 * @see SoftLayer_Virtual_Guest_Block_Device_Template
 */
@ApiType("SoftLayer_Virtual_Guest_Block_Device_Template")
public class Template extends Entity {

    /**
     * A block device template's disk image.
     */
    @ApiProperty
    protected Image diskImage;

    public Image getDiskImage() {
        return diskImage;
    }

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

    /**
     * A block device template's group. Several block device templates can be combined together into a group for archiving purposes.
     */
    @ApiProperty
    protected Group group;

    public Group getGroup() {
        return group;
    }

    public void setGroup(Group group) {
        this.group = group;
    }

    /**
     * A name that identifies a block device template. 
     */
    @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 template's [[SoftLayer_Virtual_Disk_Image|disk image]] 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 amount of disk space that a block device template is using.  Use this number along with the units property to obtain the correct space used. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal diskSpace;

    public BigDecimal getDiskSpace() {
        return diskSpace;
    }

    public void setDiskSpace(BigDecimal diskSpace) {
        diskSpaceSpecified = true;
        this.diskSpace = diskSpace;
    }

    protected boolean diskSpaceSpecified;

    public boolean isDiskSpaceSpecified() {
        return diskSpaceSpecified;
    }

    public void unsetDiskSpace() {
        diskSpace = null;
        diskSpaceSpecified = false;
    }

    /**
     * A block device template's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|group]] ID. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long groupId;

    public Long getGroupId() {
        return groupId;
    }

    public void setGroupId(Long groupId) {
        groupIdSpecified = true;
        this.groupId = groupId;
    }

    protected boolean groupIdSpecified;

    public boolean isGroupIdSpecified() {
        return groupIdSpecified;
    }

    public void unsetGroupId() {
        groupId = null;
        groupIdSpecified = false;
    }

    /**
     * A block device template'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 units that will be used with the disk space property to identify the amount of disk space used. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String units;

    public String getUnits() {
        return units;
    }

    public void setUnits(String units) {
        unitsSpecified = true;
        this.units = units;
    }

    protected boolean unitsSpecified;

    public boolean isUnitsSpecified() {
        return unitsSpecified;
    }

    public void unsetUnits() {
        units = null;
        unitsSpecified = 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.block.device.template.Group.Mask group() {
            return withSubMask("group", com.softlayer.api.service.virtual.guest.block.device.template.Group.Mask.class);
        }

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

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

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

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

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

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

    }

}