com.softlayer.api.service.hardware.component.model.Generic 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
The newest version!
package com.softlayer.api.service.hardware.component.model;

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.Model;
import com.softlayer.api.service.hardware.component.Type;
import com.softlayer.api.service.hardware.component.model.generic.MarketingFeature;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Hardware_Component_Model_Generic data type contains general information relating to a single SoftLayer generic component model.  A generic component model represents a non-vendor specific representation of a hardware component.  Frequently SoftLayer utilizes components from various vendors in the servers they provision. For Example: Several different vendors produce 6GB DDR2 memory.  The generic component model for the 6GB stick of RAM encompasses every instance of this component regardless of make and model. 
 *
 * @see SoftLayer_Hardware_Component_Model_Generic
 */
@ApiType("SoftLayer_Hardware_Component_Model_Generic")
public class Generic extends Entity {

    /**
     * A generic component model's hardware component model.
     */
    @ApiProperty
    protected List hardwareComponentModels;

    public List getHardwareComponentModels() {
        if (hardwareComponentModels == null) {
            hardwareComponentModels = new ArrayList();
        }
        return hardwareComponentModels;
    }

    /**
     * A generic component model's type.
     */
    @ApiProperty
    protected Type hardwareComponentType;

    public Type getHardwareComponentType() {
        return hardwareComponentType;
    }

    public void setHardwareComponentType(Type hardwareComponentType) {
        this.hardwareComponentType = hardwareComponentType;
    }

    /**
     * A list of features that a generic component model can provide.
     */
    @ApiProperty
    protected MarketingFeature marketingFeatures;

    public MarketingFeature getMarketingFeatures() {
        return marketingFeatures;
    }

    public void setMarketingFeatures(MarketingFeature marketingFeatures) {
        this.marketingFeatures = marketingFeatures;
    }

    /**
     * A generic component model's capacity. The capacity of a generic component model depends on the model itself.  For Example: Hard drives have a capacity that reflects the amount of data that hard drive can store. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal capacity;

    public BigDecimal getCapacity() {
        return capacity;
    }

    public void setCapacity(BigDecimal capacity) {
        capacitySpecified = true;
        this.capacity = capacity;
    }

    protected boolean capacitySpecified;

    public boolean isCapacitySpecified() {
        return capacitySpecified;
    }

    public void unsetCapacity() {
        capacity = null;
        capacitySpecified = false;
    }

    /**
     * A brief description for a generic component model that typically defines it's function. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * The internal identifier of the component type for a generic component model. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareComponentTypeId;

    public Long getHardwareComponentTypeId() {
        return hardwareComponentTypeId;
    }

    public void setHardwareComponentTypeId(Long hardwareComponentTypeId) {
        hardwareComponentTypeIdSpecified = true;
        this.hardwareComponentTypeId = hardwareComponentTypeId;
    }

    protected boolean hardwareComponentTypeIdSpecified;

    public boolean isHardwareComponentTypeIdSpecified() {
        return hardwareComponentTypeIdSpecified;
    }

    public void unsetHardwareComponentTypeId() {
        hardwareComponentTypeId = null;
        hardwareComponentTypeIdSpecified = false;
    }

    /**
     * A generic component model's internal identification number.
     */
    @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 unit of measurement for the capacity of a generic component model. 
     */
    @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;
    }

    /**
     * A generic component model's upgrade priority. The upgrade priority indicates the order a generic component model should be considered over other generic component models. A higher number indicates that a generic component model receives a higher upgrade preference in comparison to a generic component model with a lower priority number. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long upgradePriority;

    public Long getUpgradePriority() {
        return upgradePriority;
    }

    public void setUpgradePriority(Long upgradePriority) {
        upgradePrioritySpecified = true;
        this.upgradePriority = upgradePriority;
    }

    protected boolean upgradePrioritySpecified;

    public boolean isUpgradePrioritySpecified() {
        return upgradePrioritySpecified;
    }

    public void unsetUpgradePriority() {
        upgradePriority = null;
        upgradePrioritySpecified = false;
    }

    /**
     * A count of a generic component model's hardware component model.
     */
    @ApiProperty
    protected Long hardwareComponentModelCount;

    public Long getHardwareComponentModelCount() {
        return hardwareComponentModelCount;
    }

    public void setHardwareComponentModelCount(Long hardwareComponentModelCount) {
        this.hardwareComponentModelCount = hardwareComponentModelCount;
    }

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

        public com.softlayer.api.service.hardware.component.Model.Mask hardwareComponentModels() {
            return withSubMask("hardwareComponentModels", com.softlayer.api.service.hardware.component.Model.Mask.class);
        }

        public com.softlayer.api.service.hardware.component.Type.Mask hardwareComponentType() {
            return withSubMask("hardwareComponentType", com.softlayer.api.service.hardware.component.Type.Mask.class);
        }

        public com.softlayer.api.service.hardware.component.model.generic.MarketingFeature.Mask marketingFeatures() {
            return withSubMask("marketingFeatures", com.softlayer.api.service.hardware.component.model.generic.MarketingFeature.Mask.class);
        }

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

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

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

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

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

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

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

    }

}