com.emc.vipr.client.core

Class Metering

java.lang.Object

com.emc.vipr.client.core.Metering

public class Metering
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Metering(RestClient client)

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getStatisticsForHourAsStream(java.util.Date date) Gets the statistics for the hour of the given date.
java.io.InputStream	getStatisticsForMinuteAsStream(java.util.Date date) Gets the statistics for the minute of the given date.
java.io.InputStream	getStatisticsForTimeBucketAsStream(java.lang.String timeBucket) Gets the statistics for the given time bucket, as a stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metering

public Metering(RestClient client)

Method Detail

getStatisticsForHourAsStream

public java.io.InputStream getStatisticsForHourAsStream(java.util.Date date)

Gets the statistics for the hour of the given date. This is a convenience method for: getStatisticsForTimeBucketAsStream(TimeBucketUtils.forHour(date))

Parameters:

date - the date to format as an hour time bucket.

Returns:

the stream containing the statistics as XML.

See Also:

getStatisticsForTimeBucketAsStream(String), TimeBucketUtils.forHour(Date)

getStatisticsForMinuteAsStream

public java.io.InputStream getStatisticsForMinuteAsStream(java.util.Date date)

Gets the statistics for the minute of the given date. This is a convenience method for: getStatisticsForTimeBucketAsStream(TimeBucketUtils.forMinute(date))

Parameters:

date - the date to format as a minute time bucket.

Returns:

the stream containing the statistics as XML.

See Also:

getStatisticsForTimeBucketAsStream(String), TimeBucketUtils.forMinute(Date)

getStatisticsForTimeBucketAsStream

public java.io.InputStream getStatisticsForTimeBucketAsStream(java.lang.String timeBucket)

Gets the statistics for the given time bucket, as a stream. A time bucket can be either an hour or a minute of any day, in the form of yyyy-MM-dd'T'HH for hour or yy-MM-dd'T'HH:mm for minute. API Call: GET /metering/stats?time_bucket={timeBucket}

Parameters:

timeBucket - the time bucket for which to retrieve the stats.

Returns:

the stream containing the statistics as XML. This must be closed by the client in order to release the connection.