All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.softlayer.api.service.hardware.component.Model Maven / Gradle / Ivy

There is a newer version: 0.3.4
Show newest version
package com.softlayer.api.service.hardware.component;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
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 com.softlayer.api.service.hardware.component.Firmware;
import com.softlayer.api.service.hardware.component.model.Attribute;
import com.softlayer.api.service.hardware.component.model.Generic;
import com.softlayer.api.service.hardware.component.model.attribute.Type;
import com.softlayer.api.service.hardware.component.motherboard.reboot.Time;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Hardware_Component_Model data type contains general information relating to a single SoftLayer component model.  A component model represents a vendor specific representation of a hardware component.  Every piece of hardware on a server will have a specific hardware component model. 
 *
 * @see SoftLayer_Hardware_Component_Model
 */
@ApiType("SoftLayer_Hardware_Component_Model")
public class Model extends Entity {

    @ApiProperty
    protected com.softlayer.api.service.hardware.component.model.architecture.Type architectureType;

    public com.softlayer.api.service.hardware.component.model.architecture.Type getArchitectureType() {
        return architectureType;
    }

    public void setArchitectureType(com.softlayer.api.service.hardware.component.model.architecture.Type architectureType) {
        this.architectureType = architectureType;
    }

    @ApiProperty
    protected List attributes;

    public List getAttributes() {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        return attributes;
    }

    @ApiProperty
    protected List compatibleArrayTypes;

    public List getCompatibleArrayTypes() {
        if (compatibleArrayTypes == null) {
            compatibleArrayTypes = new ArrayList();
        }
        return compatibleArrayTypes;
    }

    /**
     * All the component models that are compatible with a hardware component model.
     */
    @ApiProperty
    protected List compatibleChildComponentModels;

    public List getCompatibleChildComponentModels() {
        if (compatibleChildComponentModels == null) {
            compatibleChildComponentModels = new ArrayList();
        }
        return compatibleChildComponentModels;
    }

    /**
     * All the component models that a hardware component model is compatible with.
     */
    @ApiProperty
    protected List compatibleParentComponentModels;

    public List getCompatibleParentComponentModels() {
        if (compatibleParentComponentModels == null) {
            compatibleParentComponentModels = new ArrayList();
        }
        return compatibleParentComponentModels;
    }

    @ApiProperty
    protected Long firmwareQuantity;

    public Long getFirmwareQuantity() {
        return firmwareQuantity;
    }

    public void setFirmwareQuantity(Long firmwareQuantity) {
        this.firmwareQuantity = firmwareQuantity;
    }

    @ApiProperty
    protected List firmwares;

    public List getFirmwares() {
        if (firmwares == null) {
            firmwares = new ArrayList();
        }
        return firmwares;
    }

    /**
     * A hardware component model's physical components in inventory.
     */
    @ApiProperty
    protected List hardwareComponents;

    public List getHardwareComponents() {
        if (hardwareComponents == null) {
            hardwareComponents = new ArrayList();
        }
        return hardwareComponents;
    }

    /**
     * The non-vendor specific generic component model for a hardware component model.
     */
    @ApiProperty
    protected Generic hardwareGenericComponentModel;

    public Generic getHardwareGenericComponentModel() {
        return hardwareGenericComponentModel;
    }

    public void setHardwareGenericComponentModel(Generic hardwareGenericComponentModel) {
        this.hardwareGenericComponentModel = hardwareGenericComponentModel;
    }

    @ApiProperty
    protected Attribute infinibandCompatibleAttribute;

    public Attribute getInfinibandCompatibleAttribute() {
        return infinibandCompatibleAttribute;
    }

    public void setInfinibandCompatibleAttribute(Attribute infinibandCompatibleAttribute) {
        this.infinibandCompatibleAttribute = infinibandCompatibleAttribute;
    }

    @ApiProperty
    protected Boolean isFlexSkuCompatible;

    public Boolean getIsFlexSkuCompatible() {
        return isFlexSkuCompatible;
    }

    public void setIsFlexSkuCompatible(Boolean isFlexSkuCompatible) {
        this.isFlexSkuCompatible = isFlexSkuCompatible;
    }

    @ApiProperty
    protected Boolean isInfinibandCompatible;

    public Boolean getIsInfinibandCompatible() {
        return isInfinibandCompatible;
    }

    public void setIsInfinibandCompatible(Boolean isInfinibandCompatible) {
        this.isInfinibandCompatible = isInfinibandCompatible;
    }

    /**
     * A motherboard's average reboot time.
     */
    @ApiProperty
    protected Time rebootTime;

    public Time getRebootTime() {
        return rebootTime;
    }

    public void setRebootTime(Time rebootTime) {
        this.rebootTime = rebootTime;
    }

    /**
     * A hardware component model's type.
     */
    @ApiProperty
    protected String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    /**
     * The types of attributes that are allowed for a given hardware component model.
     */
    @ApiProperty
    protected List validAttributeTypes;

    public List getValidAttributeTypes() {
        if (validAttributeTypes == null) {
            validAttributeTypes = new ArrayList();
        }
        return validAttributeTypes;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String architectureTypeId;

    public String getArchitectureTypeId() {
        return architectureTypeId;
    }

    public void setArchitectureTypeId(String architectureTypeId) {
        architectureTypeIdSpecified = true;
        this.architectureTypeId = architectureTypeId;
    }

    protected boolean architectureTypeIdSpecified;

    public boolean isArchitectureTypeIdSpecified() {
        return architectureTypeIdSpecified;
    }

    public void unsetArchitectureTypeId() {
        architectureTypeId = null;
        architectureTypeIdSpecified = false;
    }

    /**
     * A component model's capacity. The capacity of a 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 colon delimited list of hardware component model attributes.
     */
    @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 generic component model for a component model.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareGenericComponentModelId;

    public Long getHardwareGenericComponentModelId() {
        return hardwareGenericComponentModelId;
    }

    public void setHardwareGenericComponentModelId(Long hardwareGenericComponentModelId) {
        hardwareGenericComponentModelIdSpecified = true;
        this.hardwareGenericComponentModelId = hardwareGenericComponentModelId;
    }

    protected boolean hardwareGenericComponentModelIdSpecified;

    public boolean isHardwareGenericComponentModelIdSpecified() {
        return hardwareGenericComponentModelIdSpecified;
    }

    public void unsetHardwareGenericComponentModelId() {
        hardwareGenericComponentModelId = null;
        hardwareGenericComponentModelIdSpecified = false;
    }

    /**
     * A hardware component model's internal identifier 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;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String longDescription;

    public String getLongDescription() {
        return longDescription;
    }

    public void setLongDescription(String longDescription) {
        longDescriptionSpecified = true;
        this.longDescription = longDescription;
    }

    protected boolean longDescriptionSpecified;

    public boolean isLongDescriptionSpecified() {
        return longDescriptionSpecified;
    }

    public void unsetLongDescription() {
        longDescription = null;
        longDescriptionSpecified = false;
    }

    /**
     * A hardware component model's manufacturer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String manufacturer;

    public String getManufacturer() {
        return manufacturer;
    }

    public void setManufacturer(String manufacturer) {
        manufacturerSpecified = true;
        this.manufacturer = manufacturer;
    }

    protected boolean manufacturerSpecified;

    public boolean isManufacturerSpecified() {
        return manufacturerSpecified;
    }

    public void unsetManufacturer() {
        manufacturer = null;
        manufacturerSpecified = false;
    }

    /**
     * The model name of a hardware component model.
     */
    @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;
    }

    /**
     * The model number or model description of a hardware component model.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String version;

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        versionSpecified = true;
        this.version = version;
    }

    protected boolean versionSpecified;

    public boolean isVersionSpecified() {
        return versionSpecified;
    }

    public void unsetVersion() {
        version = null;
        versionSpecified = false;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long attributeCount;

    public Long getAttributeCount() {
        return attributeCount;
    }

    public void setAttributeCount(Long attributeCount) {
        this.attributeCount = attributeCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long compatibleArrayTypeCount;

    public Long getCompatibleArrayTypeCount() {
        return compatibleArrayTypeCount;
    }

    public void setCompatibleArrayTypeCount(Long compatibleArrayTypeCount) {
        this.compatibleArrayTypeCount = compatibleArrayTypeCount;
    }

    /**
     * A count of all the component models that are compatible with a hardware component model.
     */
    @ApiProperty
    protected Long compatibleChildComponentModelCount;

    public Long getCompatibleChildComponentModelCount() {
        return compatibleChildComponentModelCount;
    }

    public void setCompatibleChildComponentModelCount(Long compatibleChildComponentModelCount) {
        this.compatibleChildComponentModelCount = compatibleChildComponentModelCount;
    }

    /**
     * A count of all the component models that a hardware component model is compatible with.
     */
    @ApiProperty
    protected Long compatibleParentComponentModelCount;

    public Long getCompatibleParentComponentModelCount() {
        return compatibleParentComponentModelCount;
    }

    public void setCompatibleParentComponentModelCount(Long compatibleParentComponentModelCount) {
        this.compatibleParentComponentModelCount = compatibleParentComponentModelCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long firmwareCount;

    public Long getFirmwareCount() {
        return firmwareCount;
    }

    public void setFirmwareCount(Long firmwareCount) {
        this.firmwareCount = firmwareCount;
    }

    /**
     * A count of the types of attributes that are allowed for a given hardware component model.
     */
    @ApiProperty
    protected Long validAttributeTypeCount;

    public Long getValidAttributeTypeCount() {
        return validAttributeTypeCount;
    }

    public void setValidAttributeTypeCount(Long validAttributeTypeCount) {
        this.validAttributeTypeCount = validAttributeTypeCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * Every hardware component is associated with a model. A hardware component model defines the type of hardware component to which it is associated. The '''SoftLayer_Hardware_Component_Model''' class provides detailed information regarding the hardware component. 
     *
     * @see SoftLayer_Hardware_Component_Model
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Hardware_Component_Model")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * getObject retrieves the SoftLayer_Hardware_Component_Model object. 
         *
         * @see SoftLayer_Hardware_Component_Model::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Model getObject();

        /**
         * @see SoftLayer_Hardware_Component_Model::getArchitectureType
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.hardware.component.model.architecture.Type getArchitectureType();

        /**
         * @see SoftLayer_Hardware_Component_Model::getAttributes
         */
        @ApiMethod(instanceRequired = true)
        public List getAttributes();

        /**
         * @see SoftLayer_Hardware_Component_Model::getCompatibleArrayTypes
         */
        @ApiMethod(instanceRequired = true)
        public List getCompatibleArrayTypes();

        /**
         * All the component models that are compatible with a hardware component model.
         *
         * @see SoftLayer_Hardware_Component_Model::getCompatibleChildComponentModels
         */
        @ApiMethod(instanceRequired = true)
        public List getCompatibleChildComponentModels();

        /**
         * All the component models that a hardware component model is compatible with.
         *
         * @see SoftLayer_Hardware_Component_Model::getCompatibleParentComponentModels
         */
        @ApiMethod(instanceRequired = true)
        public List getCompatibleParentComponentModels();

        /**
         * @see SoftLayer_Hardware_Component_Model::getFirmwareQuantity
         */
        @ApiMethod(instanceRequired = true)
        public Long getFirmwareQuantity();

        /**
         * @see SoftLayer_Hardware_Component_Model::getFirmwares
         */
        @ApiMethod(instanceRequired = true)
        public List getFirmwares();

        /**
         * A hardware component model's physical components in inventory.
         *
         * @see SoftLayer_Hardware_Component_Model::getHardwareComponents
         */
        @ApiMethod(instanceRequired = true)
        public List getHardwareComponents();

        /**
         * The non-vendor specific generic component model for a hardware component model.
         *
         * @see SoftLayer_Hardware_Component_Model::getHardwareGenericComponentModel
         */
        @ApiMethod(instanceRequired = true)
        public Generic getHardwareGenericComponentModel();

        /**
         * @see SoftLayer_Hardware_Component_Model::getInfinibandCompatibleAttribute
         */
        @ApiMethod(instanceRequired = true)
        public Attribute getInfinibandCompatibleAttribute();

        /**
         * @see SoftLayer_Hardware_Component_Model::getIsFlexSkuCompatible
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getIsFlexSkuCompatible();

        /**
         * @see SoftLayer_Hardware_Component_Model::getIsInfinibandCompatible
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getIsInfinibandCompatible();

        /**
         * A motherboard's average reboot time.
         *
         * @see SoftLayer_Hardware_Component_Model::getRebootTime
         */
        @ApiMethod(instanceRequired = true)
        public Time getRebootTime();

        /**
         * A hardware component model's type.
         *
         * @see SoftLayer_Hardware_Component_Model::getType
         */
        @ApiMethod(instanceRequired = true)
        public String getType();

        /**
         * The types of attributes that are allowed for a given hardware component model.
         *
         * @see SoftLayer_Hardware_Component_Model::getValidAttributeTypes
         */
        @ApiMethod(instanceRequired = true)
        public List getValidAttributeTypes();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getArchitectureType}
         */
        public Future getArchitectureType();

        /**
         * Async callback version of {@link Service#getArchitectureType}
         */
        public Future getArchitectureType(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAttributes}
         */
        public Future> getAttributes();

        /**
         * Async callback version of {@link Service#getAttributes}
         */
        public Future getAttributes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCompatibleArrayTypes}
         */
        public Future> getCompatibleArrayTypes();

        /**
         * Async callback version of {@link Service#getCompatibleArrayTypes}
         */
        public Future getCompatibleArrayTypes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCompatibleChildComponentModels}
         */
        public Future> getCompatibleChildComponentModels();

        /**
         * Async callback version of {@link Service#getCompatibleChildComponentModels}
         */
        public Future getCompatibleChildComponentModels(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCompatibleParentComponentModels}
         */
        public Future> getCompatibleParentComponentModels();

        /**
         * Async callback version of {@link Service#getCompatibleParentComponentModels}
         */
        public Future getCompatibleParentComponentModels(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getFirmwareQuantity}
         */
        public Future getFirmwareQuantity();

        /**
         * Async callback version of {@link Service#getFirmwareQuantity}
         */
        public Future getFirmwareQuantity(ResponseHandler callback);

        /**
         * Async version of {@link Service#getFirmwares}
         */
        public Future> getFirmwares();

        /**
         * Async callback version of {@link Service#getFirmwares}
         */
        public Future getFirmwares(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getHardwareComponents}
         */
        public Future> getHardwareComponents();

        /**
         * Async callback version of {@link Service#getHardwareComponents}
         */
        public Future getHardwareComponents(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getHardwareGenericComponentModel}
         */
        public Future getHardwareGenericComponentModel();

        /**
         * Async callback version of {@link Service#getHardwareGenericComponentModel}
         */
        public Future getHardwareGenericComponentModel(ResponseHandler callback);

        /**
         * Async version of {@link Service#getInfinibandCompatibleAttribute}
         */
        public Future getInfinibandCompatibleAttribute();

        /**
         * Async callback version of {@link Service#getInfinibandCompatibleAttribute}
         */
        public Future getInfinibandCompatibleAttribute(ResponseHandler callback);

        /**
         * Async version of {@link Service#getIsFlexSkuCompatible}
         */
        public Future getIsFlexSkuCompatible();

        /**
         * Async callback version of {@link Service#getIsFlexSkuCompatible}
         */
        public Future getIsFlexSkuCompatible(ResponseHandler callback);

        /**
         * Async version of {@link Service#getIsInfinibandCompatible}
         */
        public Future getIsInfinibandCompatible();

        /**
         * Async callback version of {@link Service#getIsInfinibandCompatible}
         */
        public Future getIsInfinibandCompatible(ResponseHandler callback);

        /**
         * Async version of {@link Service#getRebootTime}
         */
        public Future




© 2015 - 2024 Weber Informatics LLC | Privacy Policy