Package org.openstack4j.model.telemetry
Interface MeterSample
-
- All Superinterfaces:
ModelEntity,Serializable
- All Known Implementing Classes:
CeilometerMeterSample
public interface MeterSample extends ModelEntity
A single measurement for a given meter and resource.- Author:
- Jeremy Unruh
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetCounterName()Meter.TypegetCounterType()StringgetCounterUnit()FloatgetCounterVolume()StringgetMessageId()Map<String,Object>getMetadata()StringgetProjectId()StringgetRecordedAt()StringgetResourceId()StringgetSource()StringgetTimestamp()StringgetUserId()voidsetCounterName(String counterName)voidsetCounterType(Meter.Type meterType)voidsetCounterUnit(String counterUnit)voidsetCounterVolume(Float counterVolume)voidsetMessageId(String messageId)voidsetMetadata(Map<String,Object> metadata)voidsetProjectId(String projectId)voidsetRecordedAt(String date)voidsetResourceId(String resourceId)voidsetSource(String source)voidsetTimestamp(String timestamp)voidsetUserId(String userId)
-
-
-
Method Detail
-
getCounterName
String getCounterName()
- Returns:
- the name of the meter
-
setCounterName
void setCounterName(String counterName)
-
getCounterType
Meter.Type getCounterType()
- Returns:
- the type of meter
-
setCounterType
void setCounterType(Meter.Type meterType)
-
getCounterUnit
String getCounterUnit()
- Returns:
- The unit of measure for the value in the counter volume
-
setCounterUnit
void setCounterUnit(String counterUnit)
-
getCounterVolume
Float getCounterVolume()
- Returns:
- the actual measured value
-
setCounterVolume
void setCounterVolume(Float counterVolume)
-
getSource
String getSource()
- Returns:
- The ID of the source that identifies where the sample comes from
-
setSource
void setSource(String source)
-
getProjectId
String getProjectId()
- Returns:
- he ID of the project or tenant that owns the resource
-
setProjectId
void setProjectId(String projectId)
-
getUserId
String getUserId()
- Returns:
- The ID of the user who last triggered an update to the resource
-
setUserId
void setUserId(String userId)
-
getResourceId
String getResourceId()
- Returns:
- The ID of the Resource for which the measurements are taken
-
setResourceId
void setResourceId(String resourceId)
-
getTimestamp
String getTimestamp()
- Returns:
- UTC date and time when the measurement was made
-
setTimestamp
void setTimestamp(String timestamp)
-
getRecordedAt
String getRecordedAt()
- Returns:
- UTC date and time when the sample was recorded
-
setRecordedAt
void setRecordedAt(String date)
-
getMessageId
String getMessageId()
- Returns:
- A unique identifier for the sample
-
setMessageId
void setMessageId(String messageId)
-
getMetadata
Map<String,Object> getMetadata()
- Returns:
- Arbitrary metadata associated with the resource
-
-