Package com.softlayer.api.service.location

Class Region

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.location.Region

@ApiType("SoftLayer_Location_Region")
public class Region
extends Entity

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 Also:

SoftLayer_Location_Region

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Region.Mask

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	A short description of a region's name.
protected boolean	descriptionSpecified
protected String	keyname	A unique key name for a region.
protected boolean	keynameSpecified
protected Location	location	Each region can have many locations tied to it.
protected Long	locationCount	A count of the locations (like datacenters or PoPs) in this region.
protected List<Location>	locations	The locations (like datacenters or PoPs) in this region.
protected Long	sortOrder	An integer representing the order in which this element is displayed.
protected boolean	sortOrderSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Region()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getKeyname()
Location	getLocation()
Long	getLocationCount()
List<Location>	getLocations()
Long	getSortOrder()
boolean	isDescriptionSpecified()
boolean	isKeynameSpecified()
boolean	isSortOrderSpecified()
void	setDescription(String description)
void	setKeyname(String keyname)
void	setLocation(Location location)
void	setLocationCount(Long locationCount)
void	setSortOrder(Long sortOrder)
void	unsetDescription()
void	unsetKeyname()
void	unsetSortOrder()

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

location

@ApiProperty
protected Location location

Each region can have many 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. (Deprecated, use 'locations')

locations

@ApiProperty
protected List<Location> locations

The locations (like datacenters or PoPs) in this region.

description

@ApiProperty(canBeNullOrNotSet=true)
protected String description

A short description of a region's name. This description is seen on the order forms.

descriptionSpecified

protected boolean descriptionSpecified

keyname

@ApiProperty(canBeNullOrNotSet=true)
protected String keyname

A unique key name for a region. Provided for easy debugging. This is to be sent in with an order.

keynameSpecified

protected boolean keynameSpecified

sortOrder

@ApiProperty(canBeNullOrNotSet=true)
protected Long sortOrder

An integer representing the order in which this element is displayed.

sortOrderSpecified

protected boolean sortOrderSpecified

locationCount

@ApiProperty
protected Long locationCount

A count of the locations (like datacenters or PoPs) in this region.

Constructor Detail

Region

public Region()

Method Detail

getLocation

public Location getLocation()

setLocation

public void setLocation(Location location)

getLocations

public List<Location> getLocations()

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isDescriptionSpecified

public boolean isDescriptionSpecified()

unsetDescription

public void unsetDescription()

getKeyname

public String getKeyname()

setKeyname

public void setKeyname(String keyname)

isKeynameSpecified

public boolean isKeynameSpecified()

unsetKeyname

public void unsetKeyname()

getSortOrder

public Long getSortOrder()

setSortOrder

public void setSortOrder(Long sortOrder)

isSortOrderSpecified

public boolean isSortOrderSpecified()

unsetSortOrder

public void unsetSortOrder()

getLocationCount

public Long getLocationCount()

setLocationCount

public void setLocationCount(Long locationCount)