Package com.softlayer.api.service
Interface Location.Service
-
- 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Location.ServiceAsync
asAsync()
Get an async version of this serviceList<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 memberStatus
getLocationStatus()
The current locations status.Attribute
getNetworkConfigurationAttribute()
Location
getObject()
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 presentLocation.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
Location.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this 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 interfaceMaskable
-
withMask
Location.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
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.
-
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()
-
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.
-
getViewablePopsAndDataCenters
@ApiMethod List<Location> getViewablePopsAndDataCenters()
Retrieve all viewable pop and datacenter locations.
-
getViewablepointOfPresence
@ApiMethod List<Location> getViewablepointOfPresence()
Retrieve all viewable network locations.
-
getpointOfPresence
@ApiMethod List<Location> getpointOfPresence()
Retrieve all point of presence locations.- See Also:
- SoftLayer_Location::getpointOfPresence
-
getActivePresaleEvents
@ApiMethod(instanceRequired=true) List<Event> getActivePresaleEvents()
-
getBackboneDependents
@ApiMethod(instanceRequired=true) List<Dependent> 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
-
getLocationStatus
@ApiMethod(instanceRequired=true) Status getLocationStatus()
The current locations status.- See Also:
- SoftLayer_Location::getLocationStatus
-
getNetworkConfigurationAttribute
@ApiMethod(instanceRequired=true) Attribute getNetworkConfigurationAttribute()
-
getOnlineSslVpnUserCount
@ApiMethod(instanceRequired=true) Long getOnlineSslVpnUserCount()
The total number of users online using SoftLayer's SSL VPN service for a location.
-
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
-
-