Sample (Palladio Core)

All Superinterfaces:

ModelEntity, Serializable

All Known Implementing Classes:

CeilometerSample
```
public interface Sample
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 and Description
`String`	`getCounterName()`
`Meter.Type`	`getCounterType()`
`String`	`getCounterUnit()`
`Float`	`getCounterVolume()`
`String`	`getMessageId()`
`Map<String,Object>`	`getMetadata()`
`String`	`getProjectId()`
`String`	`getRecordedAt()`
`String`	`getResourceId()`
`String`	`getSource()`
`String`	`getTimestamp()`
`String`	`getUserId()`
`void`	`setCounterName(String counterName)`
`void`	`setCounterType(Meter.Type meterType)`
`void`	`setCounterUnit(String counterUnit)`
`void`	`setCounterVolume(Float counterVolume)`
`void`	`setMessageId(String messageId)`
`void`	`setMetadata(Map<String,Object> metadata)`
`void`	`setProjectId(String projectId)`
`void`	`setRecordedAt(String date)`
`void`	`setResourceId(String resourceId)`
`void`	`setSource(String source)`
`void`	`setTimestamp(String timestamp)`
`void`	`setUserId(String userId)`

- Method Detail
  - getCounterName
```
String getCounterName()
```
    Returns:
    
    the name of the meter
  - getCounterType
```
Meter.Type getCounterType()
```
    Returns:
    
    the type of meter
  - getCounterUnit
```
String getCounterUnit()
```
    Returns:
    
    The unit of measure for the value in the counter volume
  - getCounterVolume
```
Float getCounterVolume()
```
    Returns:
    
    the actual measured value
  - getSource
```
String getSource()
```
    Returns:
    
    The ID of the source that identifies where the sample comes from
  - getProjectId
```
String getProjectId()
```
    Returns:
    
    he ID of the project or tenant that owns the resource
  - getUserId
```
String getUserId()
```
    Returns:
    
    The ID of the user who last triggered an update to the resource
  - getResourceId
```
String getResourceId()
```
    Returns:
    
    The ID of the Resource for which the measurements are taken
  - getTimestamp
```
String getTimestamp()
```
    Returns:
    
    UTC date and time when the measurement was made
  - getRecordedAt
```
String getRecordedAt()
```
    Returns:
    
    UTC date and time when the sample was recorded
  - getMessageId
```
String getMessageId()
```
    Returns:
    
    A unique identifier for the sample
  - getMetadata
```
Map<String,Object> getMetadata()
```
    Returns:
    
    Arbitrary metadata associated with the resource
  - setCounterName
```
void setCounterName(String counterName)
```
  - setCounterType
```
void setCounterType(Meter.Type meterType)
```
  - setCounterUnit
```
void setCounterUnit(String counterUnit)
```
  - setCounterVolume
```
void setCounterVolume(Float counterVolume)
```
  - setSource
```
void setSource(String source)
```
  - setProjectId
```
void setProjectId(String projectId)
```
  - setUserId
```
void setUserId(String userId)
```
  - setResourceId
```
void setResourceId(String resourceId)
```
  - setTimestamp
```
void setTimestamp(String timestamp)
```
  - setRecordedAt
```
void setRecordedAt(String date)
```
  - setMessageId
```
void setMessageId(String messageId)
```
  - setMetadata
```
void setMetadata(Map<String,Object> metadata)
```

Interface Sample

Method Summary

Method Detail

getCounterName

getCounterType

getCounterUnit

getCounterVolume

getSource

getProjectId

getUserId

getResourceId

getTimestamp

getRecordedAt

getMessageId

getMetadata

setCounterName

setCounterType

setCounterUnit

setCounterVolume

setSource

setProjectId

setUserId

setResourceId

setTimestamp

setRecordedAt

setMessageId

setMetadata