Package com.softlayer.api.service.network

Interface Backbone.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Backbone

@ApiService("SoftLayer_Network_Backbone")
public static interface Backbone.Service
extends Service

A SoftLayer_Network_Backbone represents a single backbone connection from SoftLayer to the public Internet, from the Internet to the SoftLayer private network, or a link that connects the private networks between SoftLayer's datacenters. The SoftLayer_Network_Backbone service is unique in that it is not referenced by any of the other SoftLayer API services.

See Also:

SoftLayer_Network_Backbone

Method Summary

Modifier and Type	Method	Description
Backbone.ServiceAsync	asAsync()	Get an async version of this service
List<Backbone>	getAllBackbones()	Retrieve a list of all SoftLayer backbone connections.
List<Backbone>	getBackbonesForLocationName(String locationName)	Retrieve a list of all SoftLayer backbone connections for a location name.
byte[]	getGraphImage()	Retrieve a graph of a SoftLayer backbone's last 24 hours of activity.
String	getHealth()	A backbone's status.
Location	getLocation()	Which of the SoftLayer datacenters a backbone is connected to.
Component	getNetworkComponent()	A backbone's primary network component.
Backbone	getObject()	Retrieve an individual SoftLayer_Network_Backbone record.
void	setMask(Backbone.Mask mask)
Backbone.Mask	withMask()	Use the existing mask on this service or create it if not present
Backbone.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 Detail

asAsync

Backbone.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Backbone.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

Backbone.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(Backbone.Mask mask)

getAllBackbones

@ApiMethod
List<Backbone> getAllBackbones()

Retrieve a list of all SoftLayer backbone connections. Use this method if you need all backbones or don't know the id number of a specific backbone.

See Also:

SoftLayer_Network_Backbone::getAllBackbones

getBackbonesForLocationName

@ApiMethod
List<Backbone> getBackbonesForLocationName(String locationName)

Retrieve a list of all SoftLayer backbone connections for a location name.

See Also:

SoftLayer_Network_Backbone::getBackbonesForLocationName

getGraphImage

@ApiMethod(instanceRequired=true)
byte[] getGraphImage()

Retrieve a graph of a SoftLayer backbone's last 24 hours of activity. getGraphImage returns a PNG image measuring 827 pixels by 293 pixels.

See Also:

SoftLayer_Network_Backbone::getGraphImage

getObject

@ApiMethod(instanceRequired=true)
Backbone getObject()

Retrieve an individual SoftLayer_Network_Backbone record. Use the getAllBackbones() method to retrieve a list of all SoftLayer network backbones.

See Also:

SoftLayer_Network_Backbone::getObject

getHealth

@ApiMethod(instanceRequired=true)
String getHealth()

A backbone's status.

See Also:

SoftLayer_Network_Backbone::getHealth

getLocation

@ApiMethod(instanceRequired=true)
Location getLocation()

Which of the SoftLayer datacenters a backbone is connected to.

See Also:

SoftLayer_Network_Backbone::getLocation

getNetworkComponent

@ApiMethod(instanceRequired=true)
Component getNetworkComponent()

A backbone's primary network component.

See Also:

SoftLayer_Network_Backbone::getNetworkComponent