java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.Location

Direct Known Subclasses:

Center, Datacenter, Office, Rack, Room, Room, Room, Root, Slot
```
@ApiType("SoftLayer_Location")
public class Location
extends Entity
```
Every piece of hardware and network connection owned by SoftLayer is tracked physically by location and stored in the SoftLayer_Location data type. SoftLayer locations exist in parent/child relationships, a convenient way to track equipment from it's city, datacenter, server room, rack, then slot. Network backbones are tied to datacenters only, not to a room, rack, or slot.

See Also:

SoftLayer_Location

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Location.Mask`
`static interface`	`Location.Service`	The SoftLayer_Location API service queries SoftLayer's location tree to find locations for all softlayer resources including bare metal servers, virtual servers, storage repositories, datacenters, points of presence, network backbones, and many more.
`static interface`	`Location.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Long`	`activePresaleEventCount`	A count of
`protected List<Event>`	`activePresaleEvents`
`protected Long`	`backboneDependentCount`	A count of
`protected List<Dependent>`	`backboneDependents`
`protected Boolean`	`bnppCompliantFlag`	A flag indicating whether or not the datacenter/location is BNPP compliant.
`protected Boolean`	`euCompliantFlag`	A flag indicating whether or not the datacenter/location is EU compliant.
`protected Long`	`groupCount`	A count of a location can be a member of 1 or more groups.
`protected List<Group>`	`groups`	A location can be a member of 1 or more groups.
`protected Long`	`hardwareFirewallCount`	A count of
`protected List<Hardware>`	`hardwareFirewalls`
`protected Long`	`id`	The unique identifier of a specific location.
`protected boolean`	`idSpecified`
`protected Address`	`locationAddress`	A location's physical address.
`protected Long`	`locationAddressCount`	A count of a location's physical addresses.
`protected List<Address>`	`locationAddresses`	A location's physical addresses.
`protected Member`	`locationReservationMember`	A location's Dedicated Rack member
`protected Status`	`locationStatus`	The current locations status.
`protected String`	`longName`	A longer location description.
`protected boolean`	`longNameSpecified`
`protected String`	`name`	A short location description.
`protected boolean`	`nameSpecified`
`protected Attribute`	`networkConfigurationAttribute`
`protected Long`	`onlineSslVpnUserCount`	The total number of users online using SoftLayer's SSL VPN service for a location.
`protected String`	`pathString`
`protected Long`	`priceGroupCount`	A count of a location can be a member of 1 or more Price Groups.
`protected List<Group>`	`priceGroups`	A location can be a member of 1 or more Price Groups.
`protected Long`	`regionCount`	A count of a location can be a member of 1 or more regions.
`protected List<Region>`	`regions`	A location can be a member of 1 or more regions.
`protected Long`	`statusId`
`protected boolean`	`statusIdSpecified`
`protected Timezone`	`timezone`
`protected CrossReference`	`vdrGroup`	A location can be a member of 1 Bandwidth Pooling Group.

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Location()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Location.Service`	`asService(ApiClient client)`
`Long`	`getActivePresaleEventCount()`
`List<Event>`	`getActivePresaleEvents()`
`Long`	`getBackboneDependentCount()`
`List<Dependent>`	`getBackboneDependents()`
`Boolean`	`getBnppCompliantFlag()`
`Boolean`	`getEuCompliantFlag()`
`Long`	`getGroupCount()`
`List<Group>`	`getGroups()`
`Long`	`getHardwareFirewallCount()`
`List<Hardware>`	`getHardwareFirewalls()`
`Long`	`getId()`
`Address`	`getLocationAddress()`
`Long`	`getLocationAddressCount()`
`List<Address>`	`getLocationAddresses()`
`Member`	`getLocationReservationMember()`
`Status`	`getLocationStatus()`
`String`	`getLongName()`
`String`	`getName()`
`Attribute`	`getNetworkConfigurationAttribute()`
`Long`	`getOnlineSslVpnUserCount()`
`String`	`getPathString()`
`Long`	`getPriceGroupCount()`
`List<Group>`	`getPriceGroups()`
`Long`	`getRegionCount()`
`List<Region>`	`getRegions()`
`Long`	`getStatusId()`
`Timezone`	`getTimezone()`
`CrossReference`	`getVdrGroup()`
`boolean`	`isIdSpecified()`
`boolean`	`isLongNameSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isStatusIdSpecified()`
`static Location.Service`	`service(ApiClient client)`
`static Location.Service`	`service(ApiClient client, Long id)`
`void`	`setActivePresaleEventCount(Long activePresaleEventCount)`
`void`	`setBackboneDependentCount(Long backboneDependentCount)`
`void`	`setBnppCompliantFlag(Boolean bnppCompliantFlag)`
`void`	`setEuCompliantFlag(Boolean euCompliantFlag)`
`void`	`setGroupCount(Long groupCount)`
`void`	`setHardwareFirewallCount(Long hardwareFirewallCount)`
`void`	`setId(Long id)`
`void`	`setLocationAddress(Address locationAddress)`
`void`	`setLocationAddressCount(Long locationAddressCount)`
`void`	`setLocationReservationMember(Member locationReservationMember)`
`void`	`setLocationStatus(Status locationStatus)`
`void`	`setLongName(String longName)`
`void`	`setName(String name)`
`void`	`setNetworkConfigurationAttribute(Attribute networkConfigurationAttribute)`
`void`	`setOnlineSslVpnUserCount(Long onlineSslVpnUserCount)`
`void`	`setPathString(String pathString)`
`void`	`setPriceGroupCount(Long priceGroupCount)`
`void`	`setRegionCount(Long regionCount)`
`void`	`setStatusId(Long statusId)`
`void`	`setTimezone(Timezone timezone)`
`void`	`setVdrGroup(CrossReference vdrGroup)`
`void`	`unsetId()`
`void`	`unsetLongName()`
`void`	`unsetName()`
`void`	`unsetStatusId()`

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
- activePresaleEvents
```
@ApiProperty
protected List<Event> activePresaleEvents
```
- backboneDependents
```
@ApiProperty
protected List<Dependent> backboneDependents
```
- bnppCompliantFlag
```
@ApiProperty
protected Boolean bnppCompliantFlag
```
  A flag indicating whether or not the datacenter/location is BNPP compliant.
- euCompliantFlag
```
@ApiProperty
protected Boolean euCompliantFlag
```
  A flag indicating whether or not the datacenter/location is EU compliant.
- groups
```
@ApiProperty
protected List<Group> groups
```
  A location can be a member of 1 or more groups. This will show which groups to which a location belongs.
- hardwareFirewalls
```
@ApiProperty
protected List<Hardware> hardwareFirewalls
```
- locationAddress
```
@ApiProperty
protected Address locationAddress
```
  A location's physical address.
- locationAddresses
```
@ApiProperty
protected List<Address> locationAddresses
```
  A location's physical addresses.
- locationReservationMember
```
@ApiProperty
protected Member locationReservationMember
```
  A location's Dedicated Rack member
- locationStatus
```
@ApiProperty
protected Status locationStatus
```
  The current locations status.
- networkConfigurationAttribute
```
@ApiProperty
protected Attribute networkConfigurationAttribute
```
- onlineSslVpnUserCount
```
@ApiProperty
protected Long onlineSslVpnUserCount
```
  The total number of users online using SoftLayer's SSL VPN service for a location.
- pathString
```
@ApiProperty
protected String pathString
```
- priceGroups
```
@ApiProperty
protected List<Group> priceGroups
```
  A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.
- regions
```
@ApiProperty
protected List<Region> regions
```
  A location can be a member of 1 or more regions. This will show which regions to which a location belongs.
- timezone
```
@ApiProperty
protected Timezone timezone
```
- vdrGroup
```
@ApiProperty
protected CrossReference vdrGroup
```
  A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs.
- id
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long id
```
  The unique identifier of a specific location.
- idSpecified
```
protected boolean idSpecified
```
- longName
```
@ApiProperty(canBeNullOrNotSet=true)
protected String longName
```
  A longer location description.
- longNameSpecified
```
protected boolean longNameSpecified
```
- name
```
@ApiProperty(canBeNullOrNotSet=true)
protected String name
```
  A short location description.
- nameSpecified
```
protected boolean nameSpecified
```
- statusId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long statusId
```
- statusIdSpecified
```
protected boolean statusIdSpecified
```
- activePresaleEventCount
```
@ApiProperty
protected Long activePresaleEventCount
```
  A count of
- backboneDependentCount
```
@ApiProperty
protected Long backboneDependentCount
```
  A count of
- groupCount
```
@ApiProperty
protected Long groupCount
```
  A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs.
- hardwareFirewallCount
```
@ApiProperty
protected Long hardwareFirewallCount
```
  A count of
- locationAddressCount
```
@ApiProperty
protected Long locationAddressCount
```
  A count of a location's physical addresses.
- priceGroupCount
```
@ApiProperty
protected Long priceGroupCount
```
  A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.
- regionCount
```
@ApiProperty
protected Long regionCount
```
  A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs.

Constructor Detail
- Location
```
public Location()
```

Method Detail

getActivePresaleEvents

public List<Event> getActivePresaleEvents()

getBackboneDependents

public List<Dependent> getBackboneDependents()

getBnppCompliantFlag
```
public Boolean getBnppCompliantFlag()
```

setBnppCompliantFlag

public void setBnppCompliantFlag(Boolean bnppCompliantFlag)

getEuCompliantFlag
```
public Boolean getEuCompliantFlag()
```

setEuCompliantFlag

public void setEuCompliantFlag(Boolean euCompliantFlag)

getGroups
```
public List<Group> getGroups()
```

getHardwareFirewalls

public List<Hardware> getHardwareFirewalls()

getLocationAddress
```
public Address getLocationAddress()
```

setLocationAddress

public void setLocationAddress(Address locationAddress)

getLocationAddresses

public List<Address> getLocationAddresses()

getLocationReservationMember

public Member getLocationReservationMember()

setLocationReservationMember

public void setLocationReservationMember(Member locationReservationMember)

getLocationStatus
```
public Status getLocationStatus()
```

setLocationStatus

public void setLocationStatus(Status locationStatus)

getNetworkConfigurationAttribute

public Attribute getNetworkConfigurationAttribute()

setNetworkConfigurationAttribute

public void setNetworkConfigurationAttribute(Attribute networkConfigurationAttribute)

getOnlineSslVpnUserCount

public Long getOnlineSslVpnUserCount()

setOnlineSslVpnUserCount

public void setOnlineSslVpnUserCount(Long onlineSslVpnUserCount)

getPathString
```
public String getPathString()
```

setPathString

public void setPathString(String pathString)

getPriceGroups
```
public List<Group> getPriceGroups()
```

getRegions
```
public List<Region> getRegions()
```

getTimezone
```
public Timezone getTimezone()
```

setTimezone

public void setTimezone(Timezone timezone)

getVdrGroup
```
public CrossReference getVdrGroup()
```

setVdrGroup

public void setVdrGroup(CrossReference vdrGroup)

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getLongName
```
public String getLongName()
```

setLongName

public void setLongName(String longName)

isLongNameSpecified
```
public boolean isLongNameSpecified()
```

unsetLongName
```
public void unsetLongName()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isNameSpecified
```
public boolean isNameSpecified()
```

unsetName
```
public void unsetName()
```

getStatusId
```
public Long getStatusId()
```

setStatusId

public void setStatusId(Long statusId)

isStatusIdSpecified
```
public boolean isStatusIdSpecified()
```

unsetStatusId
```
public void unsetStatusId()
```

getActivePresaleEventCount

public Long getActivePresaleEventCount()

setActivePresaleEventCount

public void setActivePresaleEventCount(Long activePresaleEventCount)

getBackboneDependentCount

public Long getBackboneDependentCount()

setBackboneDependentCount

public void setBackboneDependentCount(Long backboneDependentCount)

getGroupCount
```
public Long getGroupCount()
```

setGroupCount

public void setGroupCount(Long groupCount)

getHardwareFirewallCount

public Long getHardwareFirewallCount()

setHardwareFirewallCount

public void setHardwareFirewallCount(Long hardwareFirewallCount)

getLocationAddressCount
```
public Long getLocationAddressCount()
```

setLocationAddressCount

public void setLocationAddressCount(Long locationAddressCount)

getPriceGroupCount
```
public Long getPriceGroupCount()
```

setPriceGroupCount

public void setPriceGroupCount(Long priceGroupCount)

getRegionCount
```
public Long getRegionCount()
```

setRegionCount

public void setRegionCount(Long regionCount)

asService

public Location.Service asService(ApiClient client)

service

public static Location.Service service(ApiClient client)

service

public static Location.Service service(ApiClient client,
                                       Long id)

Class Location

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

activePresaleEvents

backboneDependents

bnppCompliantFlag

euCompliantFlag

groups

hardwareFirewalls

locationAddress

locationAddresses

locationReservationMember

locationStatus

networkConfigurationAttribute

onlineSslVpnUserCount

pathString

priceGroups

regions

timezone

vdrGroup

id

idSpecified

longName

longNameSpecified

name

nameSpecified

statusId

statusIdSpecified

activePresaleEventCount

backboneDependentCount

groupCount

hardwareFirewallCount

locationAddressCount

priceGroupCount

regionCount

Constructor Detail

Location

Method Detail

getActivePresaleEvents

getBackboneDependents

getBnppCompliantFlag

setBnppCompliantFlag

getEuCompliantFlag

setEuCompliantFlag

getGroups

getHardwareFirewalls

getLocationAddress

setLocationAddress

getLocationAddresses

getLocationReservationMember

setLocationReservationMember

getLocationStatus

setLocationStatus

getNetworkConfigurationAttribute

setNetworkConfigurationAttribute

getOnlineSslVpnUserCount

setOnlineSslVpnUserCount

getPathString

setPathString

getPriceGroups

getRegions

getTimezone

setTimezone

getVdrGroup

setVdrGroup

getId

setId

isIdSpecified

unsetId

getLongName

setLongName

isLongNameSpecified

unsetLongName

getName