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

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;
import com.softlayer.api.service.product.pkg.Locations;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Location_Region_Location is very specific to the location where services will actually be provisioned. When accessed through a package, this location is the top priority location for a region. All new servers and services are provisioned at this location. When a server is ordered and a region is selected, this is the location within that region where the server will actually exist and have software/services installed. 
 *
 * @see SoftLayer_Location_Region_Location
 */
@ApiType("SoftLayer_Location_Region_Location")
public class Location extends Entity {

    /**
     * The SoftLayer_Location tied to a region's location. This provides more information about the location, including specific datacenter information.
     */
    @ApiProperty
    protected com.softlayer.api.service.Location location;

    public com.softlayer.api.service.Location getLocation() {
        return location;
    }

    public void setLocation(com.softlayer.api.service.Location location) {
        this.location = location;
    }

    /**
     * A region's location also has delivery information as well as other information to be determined. For now, availability is provided and could weigh into the decision as to where to decide to have a server provisioned.'
     */
    @ApiProperty
    protected List locationPackageDetails;

    public List getLocationPackageDetails() {
        if (locationPackageDetails == null) {
            locationPackageDetails = new ArrayList();
        }
        return locationPackageDetails;
    }

    /**
     * The region to which this location belongs.
     */
    @ApiProperty
    protected Region region;

    public Region getRegion() {
        return region;
    }

    public void setRegion(Region region) {
        this.region = region;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Long locationId;

    public Long getLocationId() {
        return locationId;
    }

    public void setLocationId(Long locationId) {
        locationIdSpecified = true;
        this.locationId = locationId;
    }

    protected boolean locationIdSpecified;

    public boolean isLocationIdSpecified() {
        return locationIdSpecified;
    }

    public void unsetLocationId() {
        locationId = null;
        locationIdSpecified = false;
    }

    /**
     * A count of a region's location also has delivery information as well as other information to be determined. For now, availability is provided and could weigh into the decision as to where to decide to have a server provisioned.'
     */
    @ApiProperty
    protected Long locationPackageDetailCount;

    public Long getLocationPackageDetailCount() {
        return locationPackageDetailCount;
    }

    public void setLocationPackageDetailCount(Long locationPackageDetailCount) {
        this.locationPackageDetailCount = locationPackageDetailCount;
    }

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

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

        public com.softlayer.api.service.product.pkg.Locations.Mask locationPackageDetails() {
            return withSubMask("locationPackageDetails", com.softlayer.api.service.product.pkg.Locations.Mask.class);
        }

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

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

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

    }

}