com.softlayer.api.service.location.Region Maven / Gradle / Ivy

Go to download
package com.softlayer.api.service.location;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.location.region.Location;

/**
 * A region is made up of a keyname and a description of that region. A region keyname can be used as part of an order. Check the SoftLayer_Product_Order service for more details. 
 *
 * @see SoftLayer_Location_Region
 */
@ApiType("SoftLayer_Location_Region")
public class Region extends Entity {

    /**
     * Each region can have many datacenter locations tied to it. However, this is the location we currently provision to for a region. This location is the current valid location for a region.
     */
    @ApiProperty
    protected Location location;

    public Location getLocation() {
        return location;
    }

    public void setLocation(Location location) {
        this.location = location;
    }

    /**
     * a short description of a region's name. This description is seen on the order forms.
     */
    @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;
    }

    /**
     * A unique key name for a region. Provided for easy debugging. This is to be sent in with an order.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String keyname;

    public String getKeyname() {
        return keyname;
    }

    public void setKeyname(String keyname) {
        keynameSpecified = true;
        this.keyname = keyname;
    }

    protected boolean keynameSpecified;

    public boolean isKeynameSpecified() {
        return keynameSpecified;
    }

    public void unsetKeyname() {
        keyname = null;
        keynameSpecified = false;
    }

    /**
     * An integer representing the order in which this element is displayed.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sortOrder;

    public Long getSortOrder() {
        return sortOrder;
    }

    public void setSortOrder(Long sortOrder) {
        sortOrderSpecified = true;
        this.sortOrder = sortOrder;
    }

    protected boolean sortOrderSpecified;

    public boolean isSortOrderSpecified() {
        return sortOrderSpecified;
    }

    public void unsetSortOrder() {
        sortOrder = null;
        sortOrderSpecified = false;
    }

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

        public com.softlayer.api.service.location.region.Location.Mask location() {
            return withSubMask("location", com.softlayer.api.service.location.region.Location.Mask.class);
        }

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

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

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

    }

}