com.softlayer.api.service.hardware.component.Partition 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.hardware.component;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.hardware.Component;
import java.math.BigDecimal;

/**
 * The SoftLayer_Hardware_Component_Partition data type contains general information relating to a single hard drive partition. 
 *
 * @see SoftLayer_Hardware_Component_Partition
 */
@ApiType("SoftLayer_Hardware_Component_Partition")
public class Partition extends Entity {

    /**
     * A hardware component partitions's associated [[SoftLayer_Hardware_Component|Hardware Component]]. Likely to be a [[SoftLayer_Hardware_Component_HardDrive|Hard Drive]]
     */
    @ApiProperty
    protected Component hardwareComponent;

    public Component getHardwareComponent() {
        return hardwareComponent;
    }

    public void setHardwareComponent(Component hardwareComponent) {
        this.hardwareComponent = hardwareComponent;
    }

    /**
     * A hardware component partition's order in the [[SoftLayer_Hardware_Hardware|hardware]].
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long diskNumber;

    public Long getDiskNumber() {
        return diskNumber;
    }

    public void setDiskNumber(Long diskNumber) {
        diskNumberSpecified = true;
        this.diskNumber = diskNumber;
    }

    protected boolean diskNumberSpecified;

    public boolean isDiskNumberSpecified() {
        return diskNumberSpecified;
    }

    public void unsetDiskNumber() {
        diskNumber = null;
        diskNumberSpecified = false;
    }

    /**
     * A flag indicating if a partition is the grow partition. The grow partition will grow to fill all remaining space on a disk.  There can only be one. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long grow;

    public Long getGrow() {
        return grow;
    }

    public void setGrow(Long grow) {
        growSpecified = true;
        this.grow = grow;
    }

    protected boolean growSpecified;

    public boolean isGrowSpecified() {
        return growSpecified;
    }

    public void unsetGrow() {
        grow = null;
        growSpecified = false;
    }

    /**
     * A hardware component partition's associated [[SoftLayer_Hardware_Component|hardware component]] Id.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareComponentId;

    public Long getHardwareComponentId() {
        return hardwareComponentId;
    }

    public void setHardwareComponentId(Long hardwareComponentId) {
        hardwareComponentIdSpecified = true;
        this.hardwareComponentId = hardwareComponentId;
    }

    protected boolean hardwareComponentIdSpecified;

    public boolean isHardwareComponentIdSpecified() {
        return hardwareComponentIdSpecified;
    }

    public void unsetHardwareComponentId() {
        hardwareComponentId = null;
        hardwareComponentIdSpecified = false;
    }

    /**
     * A hardware component partition's minimum size(GB).
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal minimumSize;

    public BigDecimal getMinimumSize() {
        return minimumSize;
    }

    public void setMinimumSize(BigDecimal minimumSize) {
        minimumSizeSpecified = true;
        this.minimumSize = minimumSize;
    }

    protected boolean minimumSizeSpecified;

    public boolean isMinimumSizeSpecified() {
        return minimumSizeSpecified;
    }

    public void unsetMinimumSize() {
        minimumSize = null;
        minimumSizeSpecified = false;
    }

    /**
     * A hardware component partition's name. On a server with windows this may be 'C' and on Linux this may be '/var' 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

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

        public com.softlayer.api.service.hardware.Component.Mask hardwareComponent() {
            return withSubMask("hardwareComponent", com.softlayer.api.service.hardware.Component.Mask.class);
        }

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

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

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

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

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

    }

}