VirtualMachineReport (mws)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.plugins
[Java] Class VirtualMachineReport

java.lang.Object
  com.ace.mws.plugins.VirtualMachineReport

public class VirtualMachineReport
extends Object

A VM report consists of values for all of the known, changed properties for a specific VM resource. This typically represents changes in a specific time period (ie between the last poll and the current poll), but can also represent all known information concerning a resource (ie the first time poll is run).

For more information on reporting resources, see the Plugin Reporting section in the MWS documentation.

Authors:: bsaville

Field Summary
`private String`	`hypervisorId` The identifier for the hypervisor/node that the VM resides on.
`private String`	`id` The unique identifier for the VM, this should be lower-case but will automatically be converted if it is not in setId(String).
`private String`	`image` The image name for the VM.
`private Map`	`metrics` The VM's reported metrics.
`private String`	`pluginId` The ID of the plugin which has generated the report.
`private NodeReportPower`	`power` The VM's current power state.
`private ReportResourceMap`	`resources` The VM's resources information.
`private NodeReportState`	`state` The VM's current state.
`private Date`	`timestamp` The date that the report was made or for which the report is current.
`private Map`	`variables` The VM's variables.

Constructor Summary
`VirtualMachineReport()` Creates a new, empty VM report.
`VirtualMachineReport(String id)` Creates a new VM report for specified VM.

Method Summary
`String`	`getHypervisorId()` @see #hypervisorId
`String`	`getId()` @see #id
`String`	`getImage()` @see #image
`Map`	`getMetrics()` @see #metrics
`String`	`getPluginId()` @see #pluginId
`NodeReportPower`	`getPower()` @see #power
`ReportResourceMap`	`getResources()` @see #resources
`NodeReportState`	`getState()` @see #state
`Date`	`getTimestamp()` Retrieves the set timestamp for the report.
`Map`	`getVariables()` @see #variables
`void`	`setHypervisorId(String hypervisorId)` @see #hypervisorId
`void`	`setId(String id)` @see #id
`void`	`setImage(String image)` Sets the image name for the VM.
`void`	`setMetrics(Map metrics)` @see #metrics
`void`	`setPluginId(String pluginId)` Sets the ID of the plugin which has generated the report.
`void`	`setPower(NodeReportPower power)` @see #power
`void`	`setPower(String power)` Calls NodeReportPower.parse to set the power field.
`void`	`setResources(ReportResourceMap resources)` @see #resources
`void`	`setState(NodeReportState state)` @see #state
`void`	`setState(String state)` Calls NodeReportState.parse to set the state field.
`void`	`setTimestamp(Date timestamp)` @see #timestamp
`void`	`setTimestamp(String timestamp)` @see #timestamp
`void`	`setVariables(Map variables)` @see #variables

Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Field Detail

hypervisorId

private String hypervisorId

The identifier for the hypervisor/node that the VM resides on.

id

private String id

The unique identifier for the VM, this should be lower-case but will automatically be converted if it is not in setId(String).

image

private String image

The image name for the VM. This is used along with the MWS Image Catalog to retrieve operating system information.

metrics

private Map metrics

The VM's reported metrics.

pluginId

private String pluginId

The ID of the plugin which has generated the report. NOTE: This is overridden by the RM services automatically and should not be set by the plugin.

power

private NodeReportPower power

The VM's current power state.

resources

private ReportResourceMap resources

The VM's resources information. Note that no null checks are needed to act on the resources.

state

private NodeReportState state

The VM's current state.

timestamp

private Date timestamp

The date that the report was made or for which the report is current. This will be set to the current date and time if not provided. This may also be set as a string which will use PluginConstants.STANDARD_DATE_FORMAT to parse into a date.

variables

private Map variables

The VM's variables.

Constructor Detail