com.softlayer.api.service.hardware.State 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.Entity;
import com.softlayer.api.service.device.Status;

/**
 * The SoftLayer_Hardware_State type contains general information about the current state of it's associated hardware, including the current power state (i.e. Running or Stopped), and it's current transitioning state (e.g. Provisioning, Reloading). 
 *
 * @see SoftLayer_Hardware_State
 */
@ApiType("SoftLayer_Hardware_State")
public class State extends Entity {

    @ApiProperty
    protected Status deviceStatus;

    public Status getDeviceStatus() {
        return deviceStatus;
    }

    public void setDeviceStatus(Status deviceStatus) {
        this.deviceStatus = deviceStatus;
    }

    @ApiProperty
    protected Status transitioningStatus;

    public Status getTransitioningStatus() {
        return transitioningStatus;
    }

    public void setTransitioningStatus(Status transitioningStatus) {
        this.transitioningStatus = transitioningStatus;
    }

    /**
     * The id of the device status of the assigned hardware.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long deviceStatusId;

    public Long getDeviceStatusId() {
        return deviceStatusId;
    }

    public void setDeviceStatusId(Long deviceStatusId) {
        deviceStatusIdSpecified = true;
        this.deviceStatusId = deviceStatusId;
    }

    protected boolean deviceStatusIdSpecified;

    public boolean isDeviceStatusIdSpecified() {
        return deviceStatusIdSpecified;
    }

    public void unsetDeviceStatusId() {
        deviceStatusId = null;
        deviceStatusIdSpecified = false;
    }

    /**
     * The hardware this state is assigned to.
     */
    @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 state's unique 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;
    }

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

        public com.softlayer.api.service.device.Status.Mask deviceStatus() {
            return withSubMask("deviceStatus", com.softlayer.api.service.device.Status.Mask.class);
        }

        public com.softlayer.api.service.device.Status.Mask transitioningStatus() {
            return withSubMask("transitioningStatus", com.softlayer.api.service.device.Status.Mask.class);
        }

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

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

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

    }

}