Package com.softlayer.api.service.metric.tracking

Interface Object.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Object

@ApiService("SoftLayer_Metric_Tracking_Object")
public static interface Object.Service
extends Service

Metric tracking objects provides a common interface to all metrics provided by SoftLayer. These metrics range from network component traffic for a server to aggregated Bandwidth Pooling traffic and more. Every object within SoftLayer's range of objects that has data that can be tracked over time has an associated tracking object.

The SoftLayer_Metric_Tracking_Object service contains methods that allow users to retrieve data from these tracking objects in raw and graph form.

See Also:

SoftLayer_Metric_Tracking_Object

Method Summary

Modifier and Type	Method	Description
Object.ServiceAsync	asAsync()	Get an async version of this service
GraphOutputs	getBackboneBandwidthGraph(String graphTitle)	[DEPRECATED] Retrieve a PNG image of the last 24 hours of bandwidth usage of one of SoftLayer's network backbones.
List<Data>	getBandwidthData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String type, Long rollupSeconds)	Retrieve a collection of raw bandwidth data from an individual public or private network tracking object.
GraphOutputs	getBandwidthGraph(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String graphType, Long fontSize, Long graphWidth, Long graphHeight, Boolean doNotShowTimeZone)	Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers.
Long	getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String type)	Retrieve the total amount of bandwidth recorded by a tracking object within the given date range.
Graph	getCustomGraphData(Graph graphContainer)	Returns a graph container instance that is populated with metric data for the tracking object.
List<Details>	getDetailsForDateRange(GregorianCalendar startDate, GregorianCalendar endDate, List<String> graphType)	Retrieve a collection of detailed metric data over a date range.
GraphOutputs	getGraph(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<String> graphType)	Retrieve a PNG image of a metric in graph form.
List<Type>	getMetricDataTypes()	Returns a collection of metric data types that can be retrieved for a metric tracking object.
Object	getObject()	getObject retrieves the SoftLayer_Metric_Tracking_Object object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Metric_Tracking_Object service.
Summary	getSummary(String graphType)	Retrieve a metric summary.
List<Data>	getSummaryData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Type> validTypes, Long summaryPeriod)	Returns summarized metric data for the date range, metric type and summary period provided.
Type	getType()	The type of data that a tracking object polls.
void	setMask(Object.Mask mask)
Object.Mask	withMask()	Use the existing mask on this service or create it if not present
Object.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

Object.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

getBackboneBandwidthGraph

@ApiMethod(instanceRequired=true) GraphOutputs getBackboneBandwidthGraph(String graphTitle)

[DEPRECATED] Retrieve a PNG image of the last 24 hours of bandwidth usage of one of SoftLayer's network backbones.

See Also:

SoftLayer_Metric_Tracking_Object::getBackboneBandwidthGraph

getBandwidthData

@ApiMethod(instanceRequired=true) List<Data> getBandwidthData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String type, Long rollupSeconds)

Retrieve a collection of raw bandwidth data from an individual public or private network tracking object. Raw data is ideal if you with to employ your own traffic storage and graphing systems.

See Also:

SoftLayer_Metric_Tracking_Object::getBandwidthData

getBandwidthGraph

@ApiMethod(instanceRequired=true) GraphOutputs getBandwidthGraph(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String graphType, Long fontSize, Long graphWidth, Long graphHeight, Boolean doNotShowTimeZone)

Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers.

See Also:

SoftLayer_Metric_Tracking_Object::getBandwidthGraph

getBandwidthTotal

@ApiMethod(instanceRequired=true) Long getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String type)

Retrieve the total amount of bandwidth recorded by a tracking object within the given date range. This method will only work on SoftLayer_Metric_Tracking_Object for SoftLayer_Hardware objects, and SoftLayer_Virtual_Guest objects.

See Also:

SoftLayer_Metric_Tracking_Object::getBandwidthTotal

getCustomGraphData

@ApiMethod(instanceRequired=true) Graph getCustomGraphData(Graph graphContainer)

Returns a graph container instance that is populated with metric data for the tracking object.

See Also:

SoftLayer_Metric_Tracking_Object::getCustomGraphData

getDetailsForDateRange

@ApiMethod(instanceRequired=true) List<Details> getDetailsForDateRange(GregorianCalendar startDate, GregorianCalendar endDate, List<String> graphType)

Retrieve a collection of detailed metric data over a date range. Ideal if you want to employ your own graphing systems. Note not all metrics support this method. Those that do not return null.

See Also:

SoftLayer_Metric_Tracking_Object::getDetailsForDateRange

getGraph

@ApiMethod(instanceRequired=true) GraphOutputs getGraph(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<String> graphType)

Retrieve a PNG image of a metric in graph form.

See Also:

SoftLayer_Metric_Tracking_Object::getGraph

getMetricDataTypes

@ApiMethod(instanceRequired=true) List<Type> getMetricDataTypes()

Returns a collection of metric data types that can be retrieved for a metric tracking object.

See Also:

SoftLayer_Metric_Tracking_Object::getMetricDataTypes

getObject

@ApiMethod(instanceRequired=true) Object getObject()

getObject retrieves the SoftLayer_Metric_Tracking_Object object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Metric_Tracking_Object service. You can only tracking objects that are associated with your SoftLayer account or services.

See Also:

SoftLayer_Metric_Tracking_Object::getObject

getSummary

@ApiMethod(instanceRequired=true) Summary getSummary(String graphType)

Retrieve a metric summary. Ideal if you want to employ your own graphing systems. Note not all metric types contain a summary. These return null.

See Also:

SoftLayer_Metric_Tracking_Object::getSummary

getSummaryData

@ApiMethod(instanceRequired=true) List<Data> getSummaryData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Type> validTypes, Long summaryPeriod)

Returns summarized metric data for the date range, metric type and summary period provided.

See Also:

SoftLayer_Metric_Tracking_Object::getSummaryData

getType

@ApiMethod(instanceRequired=true) Type getType()

The type of data that a tracking object polls.

See Also:

SoftLayer_Metric_Tracking_Object::getType