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

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Hardware;
import com.softlayer.api.service.configuration.storage.Group;
import com.softlayer.api.service.hardware.component.Model;
import com.softlayer.api.service.hardware.component.Revision;
import com.softlayer.api.service.hardware.component.Type;
import com.softlayer.api.service.hardware.component.model.generic.Attribute;
import com.softlayer.api.service.service.Provider;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;

/**
 * The SoftLayer_Hardware_Component data type abstracts information related to a hardware component. 
 *
 * @see SoftLayer_Hardware_Component
 */
@ApiType("SoftLayer_Hardware_Component")
public class Component extends Entity {

    /**
     * A component's capacity.
     */
    @ApiProperty
    protected BigDecimal capacity;

    public BigDecimal getCapacity() {
        return capacity;
    }

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

    /**
     * A components sub components. Devices that are usually integrated or in some way attached to a component.
     */
    @ApiProperty
    protected List children;

    public List getChildren() {
        if (children == null) {
            children = new ArrayList();
        }
        return children;
    }

    /**
     * A component's Revision.
     */
    @ApiProperty
    protected String componentRevision;

    public String getComponentRevision() {
        return componentRevision;
    }

    public void setComponentRevision(String componentRevision) {
        this.componentRevision = componentRevision;
    }

    @ApiProperty
    protected List downlinkHardwareComponents;

    public List getDownlinkHardwareComponents() {
        if (downlinkHardwareComponents == null) {
            downlinkHardwareComponents = new ArrayList();
        }
        return downlinkHardwareComponents;
    }

    /**
     * The hardware object that this component belongs to.
     */
    @ApiProperty
    protected Hardware hardware;

    public Hardware getHardware() {
        return hardware;
    }

    public void setHardware(Hardware hardware) {
        this.hardware = hardware;
    }

    /**
     * The general group of component models.
     */
    @ApiProperty
    protected Model hardwareComponentModel;

    public Model getHardwareComponentModel() {
        return hardwareComponentModel;
    }

    public void setHardwareComponentModel(Model hardwareComponentModel) {
        this.hardwareComponentModel = hardwareComponentModel;
    }

    /**
     * A components type.
     */
    @ApiProperty
    protected Type hardwareComponentType;

    public Type getHardwareComponentType() {
        return hardwareComponentType;
    }

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

    @ApiProperty
    protected Boolean isChildModule;

    public Boolean getIsChildModule() {
        return isChildModule;
    }

    public void setIsChildModule(Boolean isChildModule) {
        this.isChildModule = isChildModule;
    }

    /**
     * Returns the associated logic volume storage groups for the hardware component.
     */
    @ApiProperty
    protected List logicalVolumeStorageGroups;

    public List getLogicalVolumeStorageGroups() {
        if (logicalVolumeStorageGroups == null) {
            logicalVolumeStorageGroups = new ArrayList();
        }
        return logicalVolumeStorageGroups;
    }

    /**
     * A component's M.2 SATA capacity.
     */
    @ApiProperty
    protected String m2SataSlotCapacity;

    public String getM2SataSlotCapacity() {
        return m2SataSlotCapacity;
    }

    public void setM2SataSlotCapacity(String m2SataSlotCapacity) {
        this.m2SataSlotCapacity = m2SataSlotCapacity;
    }

    /**
     * The module's hardware components
     */
    @ApiProperty
    protected List moduleComponents;

    public List getModuleComponents() {
        if (moduleComponents == null) {
            moduleComponents = new ArrayList();
        }
        return moduleComponents;
    }

    /**
     * The module's hardware components
     */
    @ApiProperty
    protected List moduleHardwareComponents;

    public List getModuleHardwareComponents() {
        if (moduleHardwareComponents == null) {
            moduleHardwareComponents = new ArrayList();
        }
        return moduleHardwareComponents;
    }

    /**
     * The module's network components
     */
    @ApiProperty
    protected List moduleNetworkComponents;

    public List getModuleNetworkComponents() {
        if (moduleNetworkComponents == null) {
            moduleNetworkComponents = new ArrayList();
        }
        return moduleNetworkComponents;
    }

    @ApiProperty
    protected List modules;

    public List getModules() {
        if (modules == null) {
            modules = new ArrayList();
        }
        return modules;
    }

    /**
     * The components local ethernet and remote management interfaces
     */
    @ApiProperty
    protected List networkComponents;

    public List getNetworkComponents() {
        if (networkComponents == null) {
            networkComponents = new ArrayList();
        }
        return networkComponents;
    }

    /**
     * The account this component belongs to.
     */
    @ApiProperty
    protected Account owner;

    public Account getOwner() {
        return owner;
    }

    public void setOwner(Account owner) {
        this.owner = owner;
    }

    /**
     * A components parent. Devices that are usually integrated or in some way attached to a component.
     */
    @ApiProperty
    protected Component parent;

    public Component getParent() {
        return parent;
    }

    public void setParent(Component parent) {
        this.parent = parent;
    }

    @ApiProperty
    protected Component parentModule;

    public Component getParentModule() {
        return parentModule;
    }

    public void setParentModule(Component parentModule) {
        this.parentModule = parentModule;
    }

    @ApiProperty
    protected Attribute prefixAttribute;

    public Attribute getPrefixAttribute() {
        return prefixAttribute;
    }

    public void setPrefixAttribute(Attribute prefixAttribute) {
        this.prefixAttribute = prefixAttribute;
    }

    /**
     * A RAID controllers RAID mode.
     */
    @ApiProperty
    protected String raidMode;

    public String getRaidMode() {
        return raidMode;
    }

    public void setRaidMode(String raidMode) {
        this.raidMode = raidMode;
    }

    /**
     * The component revision designation.
     */
    @ApiProperty
    protected Revision revision;

    public Revision getRevision() {
        return revision;
    }

    public void setRevision(Revision revision) {
        this.revision = revision;
    }

    @ApiProperty
    protected Provider serviceProvider;

    public Provider getServiceProvider() {
        return serviceProvider;
    }

    public void setServiceProvider(Provider serviceProvider) {
        this.serviceProvider = serviceProvider;
    }

    @ApiProperty
    protected List uplinkHardwareComponents;

    public List getUplinkHardwareComponents() {
        if (uplinkHardwareComponents == null) {
            uplinkHardwareComponents = new ArrayList();
        }
        return uplinkHardwareComponents;
    }

    /**
     * The internal identifier of a hardware component's component model.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareComponentModelId;

    public Long getHardwareComponentModelId() {
        return hardwareComponentModelId;
    }

    public void setHardwareComponentModelId(Long hardwareComponentModelId) {
        hardwareComponentModelIdSpecified = true;
        this.hardwareComponentModelId = hardwareComponentModelId;
    }

    protected boolean hardwareComponentModelIdSpecified;

    public boolean isHardwareComponentModelIdSpecified() {
        return hardwareComponentModelIdSpecified;
    }

    public void unsetHardwareComponentModelId() {
        hardwareComponentModelId = null;
        hardwareComponentModelIdSpecified = false;
    }

    /**
     * The internal identifier of the hardware that a hardware component resides inside.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareId;

    public Long getHardwareId() {
        return hardwareId;
    }

    public void setHardwareId(Long hardwareId) {
        hardwareIdSpecified = true;
        this.hardwareId = hardwareId;
    }

    protected boolean hardwareIdSpecified;

    public boolean isHardwareIdSpecified() {
        return hardwareIdSpecified;
    }

    public void unsetHardwareId() {
        hardwareId = null;
        hardwareIdSpecified = false;
    }

    /**
     * A hardware component's internal identifier.
     */
    @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 date that a hardware component 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 name of this component as referenced by the operating system.
     */
    @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 component serial number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serialNumber;

    public String getSerialNumber() {
        return serialNumber;
    }

    public void setSerialNumber(String serialNumber) {
        serialNumberSpecified = true;
        this.serialNumber = serialNumber;
    }

    protected boolean serialNumberSpecified;

    public boolean isSerialNumberSpecified() {
        return serialNumberSpecified;
    }

    public void unsetSerialNumber() {
        serialNumber = null;
        serialNumberSpecified = false;
    }

    /**
     * A hardware's internal identification number at its service provider
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long serviceProviderId;

    public Long getServiceProviderId() {
        return serviceProviderId;
    }

    public void setServiceProviderId(Long serviceProviderId) {
        serviceProviderIdSpecified = true;
        this.serviceProviderId = serviceProviderId;
    }

    protected boolean serviceProviderIdSpecified;

    public boolean isServiceProviderIdSpecified() {
        return serviceProviderIdSpecified;
    }

    public void unsetServiceProviderId() {
        serviceProviderId = null;
        serviceProviderIdSpecified = false;
    }

    /**
     * A count of a components sub components. Devices that are usually integrated or in some way attached to a component.
     */
    @ApiProperty
    protected Long childrenCount;

    public Long getChildrenCount() {
        return childrenCount;
    }

    public void setChildrenCount(Long childrenCount) {
        this.childrenCount = childrenCount;
    }

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

    public Long getDownlinkHardwareComponentCount() {
        return downlinkHardwareComponentCount;
    }

    public void setDownlinkHardwareComponentCount(Long downlinkHardwareComponentCount) {
        this.downlinkHardwareComponentCount = downlinkHardwareComponentCount;
    }

    /**
     * A count of returns the associated logic volume storage groups for the hardware component.
     */
    @ApiProperty
    protected Long logicalVolumeStorageGroupCount;

    public Long getLogicalVolumeStorageGroupCount() {
        return logicalVolumeStorageGroupCount;
    }

    public void setLogicalVolumeStorageGroupCount(Long logicalVolumeStorageGroupCount) {
        this.logicalVolumeStorageGroupCount = logicalVolumeStorageGroupCount;
    }

    /**
     * A count of the module's hardware components
     */
    @ApiProperty
    protected Long moduleComponentCount;

    public Long getModuleComponentCount() {
        return moduleComponentCount;
    }

    public void setModuleComponentCount(Long moduleComponentCount) {
        this.moduleComponentCount = moduleComponentCount;
    }

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

    public Long getModuleCount() {
        return moduleCount;
    }

    public void setModuleCount(Long moduleCount) {
        this.moduleCount = moduleCount;
    }

    /**
     * A count of the module's hardware components
     */
    @ApiProperty
    protected Long moduleHardwareComponentCount;

    public Long getModuleHardwareComponentCount() {
        return moduleHardwareComponentCount;
    }

    public void setModuleHardwareComponentCount(Long moduleHardwareComponentCount) {
        this.moduleHardwareComponentCount = moduleHardwareComponentCount;
    }

    /**
     * A count of the module's network components
     */
    @ApiProperty
    protected Long moduleNetworkComponentCount;

    public Long getModuleNetworkComponentCount() {
        return moduleNetworkComponentCount;
    }

    public void setModuleNetworkComponentCount(Long moduleNetworkComponentCount) {
        this.moduleNetworkComponentCount = moduleNetworkComponentCount;
    }

    /**
     * A count of the components local ethernet and remote management interfaces
     */
    @ApiProperty
    protected Long networkComponentCount;

    public Long getNetworkComponentCount() {
        return networkComponentCount;
    }

    public void setNetworkComponentCount(Long networkComponentCount) {
        this.networkComponentCount = networkComponentCount;
    }

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

    public Long getUplinkHardwareComponentCount() {
        return uplinkHardwareComponentCount;
    }

    public void setUplinkHardwareComponentCount(Long uplinkHardwareComponentCount) {
        this.uplinkHardwareComponentCount = uplinkHardwareComponentCount;
    }

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

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

        public Component.Mask children() {
            return withSubMask("children", Component.Mask.class);
        }

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

        public Component.Mask downlinkHardwareComponents() {
            return withSubMask("downlinkHardwareComponents", Component.Mask.class);
        }

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

        public com.softlayer.api.service.hardware.component.Model.Mask hardwareComponentModel() {
            return withSubMask("hardwareComponentModel", 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 Mask isChildModule() {
            withLocalProperty("isChildModule");
            return this;
        }

        public com.softlayer.api.service.configuration.storage.Group.Mask logicalVolumeStorageGroups() {
            return withSubMask("logicalVolumeStorageGroups", com.softlayer.api.service.configuration.storage.Group.Mask.class);
        }

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

        public Component.Mask moduleComponents() {
            return withSubMask("moduleComponents", Component.Mask.class);
        }

        public Component.Mask moduleHardwareComponents() {
            return withSubMask("moduleHardwareComponents", Component.Mask.class);
        }

        public Component.Mask moduleNetworkComponents() {
            return withSubMask("moduleNetworkComponents", Component.Mask.class);
        }

        public Component.Mask modules() {
            return withSubMask("modules", Component.Mask.class);
        }

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

        public com.softlayer.api.service.Account.Mask owner() {
            return withSubMask("owner", com.softlayer.api.service.Account.Mask.class);
        }

        public Component.Mask parent() {
            return withSubMask("parent", Component.Mask.class);
        }

        public Component.Mask parentModule() {
            return withSubMask("parentModule", Component.Mask.class);
        }

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

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

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

        public com.softlayer.api.service.service.Provider.Mask serviceProvider() {
            return withSubMask("serviceProvider", com.softlayer.api.service.service.Provider.Mask.class);
        }

        public Component.Mask uplinkHardwareComponents() {
            return withSubMask("uplinkHardwareComponents", Component.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}