All Superinterfaces:: Maskable, ResultLimitable, Service

All Known Subinterfaces:: Datacenter.Service

Enclosing class:: Location

@ApiService("SoftLayer_Location")
public static interface Location.Service
extends 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.

See Also:: SoftLayer_Location

Method Summary

Modifier and Type	Method	Description
`Location.ServiceAsync`	`asAsync()`	Get an async version of this service
`List<Event>`	`getActivePresaleEvents()`
`List<Location>`	`getAvailableObjectStorageDatacenters()`	Object Storage is only available in select datacenters.
`List<Dependent>`	`getBackboneDependents()`
`Boolean`	`getBnppCompliantFlag()`	A flag indicating whether or not the datacenter/location is BNPP compliant.
`List<Location>`	`getDatacenters()`	Retrieve all datacenter locations.
`List<Location>`	`getDatacentersWithVirtualImageStoreServiceResourceRecord()`
`Boolean`	`getEuCompliantFlag()`	A flag indicating whether or not the datacenter/location is EU compliant.
`List<Group>`	`getGroups()`	A location can be a member of 1 or more groups.
`List<Hardware>`	`getHardwareFirewalls()`
`Address`	`getLocationAddress()`	A location's physical address.
`List<Address>`	`getLocationAddresses()`	A location's physical addresses.
`Member`	`getLocationReservationMember()`	A location's Dedicated Rack member
`Status`	`getLocationStatus()`	The current locations status.
`Attribute`	`getNetworkConfigurationAttribute()`
`Location`	`getObject()`
`Long`	`getOnlinePptpVpnUserCount()`	The total number of users online using SoftLayer's PPTP VPN service for a location.
`Long`	`getOnlineSslVpnUserCount()`	The total number of users online using SoftLayer's SSL VPN service for a location.
`String`	`getPathString()`
`List<Location>`	`getpointOfPresence()`	Retrieve all point of presence locations.
`List<Group>`	`getPriceGroups()`	A location can be a member of 1 or more Price Groups.
`List<Region>`	`getRegions()`	A location can be a member of 1 or more regions.
`Timezone`	`getTimezone()`
`CrossReference`	`getVdrGroup()`	A location can be a member of 1 Bandwidth Pooling Group.
`List<Location>`	`getViewableDatacenters()`	Retrieve all datacenter locations.
`List<Location>`	`getViewablepointOfPresence()`	Retrieve all viewable network locations.
`List<Location>`	`getViewablePopsAndDataCenters()`	Retrieve all viewable pop and datacenter locations.
`void`	`setMask(Location.Mask mask)`
`Location.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Location.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Location.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Location.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Location.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Location.Mask mask)
- getAvailableObjectStorageDatacenters
  
  @ApiMethod List<Location> getAvailableObjectStorageDatacenters()
  
  Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available.
  
  See Also:
  
  SoftLayer_Location::getAvailableObjectStorageDatacenters
- getDatacenters
  
  @ApiMethod List<Location> getDatacenters()
  
  Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.
  
  See Also:
  
  SoftLayer_Location::getDatacenters
- getDatacentersWithVirtualImageStoreServiceResourceRecord
  
  @ApiMethod List<Location> getDatacentersWithVirtualImageStoreServiceResourceRecord()
  
  See Also:
  
  SoftLayer_Location::getDatacentersWithVirtualImageStoreServiceResourceRecord
- getObject
  
  @ApiMethod(instanceRequired=true) Location getObject()
  
  See Also:
  
  SoftLayer_Location::getObject
- getViewableDatacenters
  
  @ApiMethod List<Location> getViewableDatacenters()
  
  Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.
  
  See Also:
  
  SoftLayer_Location::getViewableDatacenters
- getViewablePopsAndDataCenters
  
  @ApiMethod List<Location> getViewablePopsAndDataCenters()
  
  Retrieve all viewable pop and datacenter locations.
  
  See Also:
  
  SoftLayer_Location::getViewablePopsAndDataCenters
- getViewablepointOfPresence
  
  @ApiMethod List<Location> getViewablepointOfPresence()
  
  Retrieve all viewable network locations.
  
  See Also:
  
  SoftLayer_Location::getViewablepointOfPresence
- getpointOfPresence
  
  @ApiMethod List<Location> getpointOfPresence()
  
  Retrieve all point of presence locations.
  
  See Also:
  
  SoftLayer_Location::getpointOfPresence
- getActivePresaleEvents
  
  @ApiMethod(instanceRequired=true) List<Event> getActivePresaleEvents()
  
  See Also:
  
  SoftLayer_Location::getActivePresaleEvents
- getBackboneDependents
  
  @ApiMethod(instanceRequired=true) List<Dependent> getBackboneDependents()
  
  See Also:
  
  SoftLayer_Location::getBackboneDependents
- getBnppCompliantFlag
  
  @ApiMethod(instanceRequired=true) Boolean getBnppCompliantFlag()
  
  A flag indicating whether or not the datacenter/location is BNPP compliant.
  
  See Also:
  
  SoftLayer_Location::getBnppCompliantFlag
- getEuCompliantFlag
  
  @ApiMethod(instanceRequired=true) Boolean getEuCompliantFlag()
  
  A flag indicating whether or not the datacenter/location is EU compliant.
  
  See Also:
  
  SoftLayer_Location::getEuCompliantFlag
- getGroups
  
  @ApiMethod(instanceRequired=true) List<Group> getGroups()
  
  A location can be a member of 1 or more groups. This will show which groups to which a location belongs.
  
  See Also:
  
  SoftLayer_Location::getGroups
- getHardwareFirewalls
  
  @ApiMethod(instanceRequired=true) List<Hardware> getHardwareFirewalls()
  
  See Also:
  
  SoftLayer_Location::getHardwareFirewalls
- getLocationAddress
  
  @ApiMethod(instanceRequired=true) Address getLocationAddress()
  
  A location's physical address.
  
  See Also:
  
  SoftLayer_Location::getLocationAddress
- getLocationAddresses
  
  @ApiMethod(instanceRequired=true) List<Address> getLocationAddresses()
  
  A location's physical addresses.
  
  See Also:
  
  SoftLayer_Location::getLocationAddresses
- getLocationReservationMember
  
  @ApiMethod(instanceRequired=true) Member getLocationReservationMember()
  
  A location's Dedicated Rack member
  
  See Also:
  
  SoftLayer_Location::getLocationReservationMember
- getLocationStatus
  
  @ApiMethod(instanceRequired=true) Status getLocationStatus()
  
  The current locations status.
  
  See Also:
  
  SoftLayer_Location::getLocationStatus
- getNetworkConfigurationAttribute
  
  @ApiMethod(instanceRequired=true) Attribute getNetworkConfigurationAttribute()
  
  See Also:
  
  SoftLayer_Location::getNetworkConfigurationAttribute
- getOnlinePptpVpnUserCount
  
  @ApiMethod(instanceRequired=true) Long getOnlinePptpVpnUserCount()
  
  The total number of users online using SoftLayer's PPTP VPN service for a location.
  
  See Also:
  
  SoftLayer_Location::getOnlinePptpVpnUserCount
- getOnlineSslVpnUserCount
  
  @ApiMethod(instanceRequired=true) Long getOnlineSslVpnUserCount()
  
  The total number of users online using SoftLayer's SSL VPN service for a location.
  
  See Also:
  
  SoftLayer_Location::getOnlineSslVpnUserCount
- getPathString
  
  @ApiMethod(instanceRequired=true) String getPathString()
  
  See Also:
  
  SoftLayer_Location::getPathString
- getPriceGroups
  
  @ApiMethod(instanceRequired=true) List<Group> getPriceGroups()
  
  A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.
  
  See Also:
  
  SoftLayer_Location::getPriceGroups
- getRegions
  
  @ApiMethod(instanceRequired=true) List<Region> getRegions()
  
  A location can be a member of 1 or more regions. This will show which regions to which a location belongs.
  
  See Also:
  
  SoftLayer_Location::getRegions
- getTimezone
  
  @ApiMethod(instanceRequired=true) Timezone getTimezone()
  
  See Also:
  
  SoftLayer_Location::getTimezone
- getVdrGroup
  
  @ApiMethod(instanceRequired=true) CrossReference getVdrGroup()
  
  A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs.
  
  See Also:
  
  SoftLayer_Location::getVdrGroup

Interface Location.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details

asAsync

withNewMask

withMask

setMask

getAvailableObjectStorageDatacenters

getDatacenters

getDatacentersWithVirtualImageStoreServiceResourceRecord

getObject

getViewableDatacenters

getViewablePopsAndDataCenters

getViewablepointOfPresence

getpointOfPresence

getActivePresaleEvents

getBackboneDependents

getBnppCompliantFlag

getEuCompliantFlag

getGroups

getHardwareFirewalls

getLocationAddress

getLocationAddresses

getLocationReservationMember

getLocationStatus

getNetworkConfigurationAttribute

getOnlinePptpVpnUserCount

getOnlineSslVpnUserCount

getPathString

getPriceGroups

getRegions

getTimezone

getVdrGroup