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

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

/**
 * SoftLayer_Location_Status models the state of any location. SoftLayer uses the following status codes: 

 * 

 * 

 * *'''ACTIVE''': The location is currently active and available for public usage.

 * *'''PLANNED''': Used when a location is planned but not yet active.

 * *'''RETIRED''': Used when a location has been retired and no longer active.

 * 

 * 

 * Locations in use should stay in the ACTIVE state. If a locations status ever reads anything else and contains active hardware then please contact SoftLayer support. 
 *
 * @see SoftLayer_Location_Status
 */
@ApiType("SoftLayer_Location_Status")
public class Status extends Entity {

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

    /**
     * A Location's status code. See the SoftLayer_Locaiton_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;
        }

    }

}