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

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;

/**
 * SoftLayer_Hardware_Status models the inventory state of any piece of hardware in SoftLayer's inventory. Most of these statuses are used by SoftLayer while a server is not provisioned or undergoing provisioning. SoftLayer uses the following status codes: 

 * 

 * 

 * *'''ACTIVE''': This server is active and in use.

 * *'''DEPLOY''': Used during server provisioning.

 * *'''DEPLOY2''': Used during server provisioning.

 * *'''MACWAIT''': Used during server provisioning.

 * *'''RECLAIM''': This server has been reclaimed by SoftLayer and is awaiting de-provisioning.

 * 

 * 

 * Servers in production and in use should stay in the ACTIVE state. If a server's status ever reads anything else then please contact SoftLayer support. 
 *
 * @see SoftLayer_Hardware_Status
 */
@ApiType("SoftLayer_Hardware_Status")
public class Status extends Entity {

    /**
     * A hardware status' 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;
    }

    /**
     * A hardware's status code. See the SoftLayer_Hardware_Status Overview for ''status''' possible values.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String status;

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        statusSpecified = true;
        this.status = status;
    }

    protected boolean statusSpecified;

    public boolean isStatusSpecified() {
        return statusSpecified;
    }

    public void unsetStatus() {
        status = null;
        statusSpecified = false;
    }

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

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

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

    }

}