Groovy Documentation

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

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

public class NodeReport
extends Object

A node report consists of values for all of the known, changed properties for a specific node 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 architecture

The node's architecture.

private List availableImages

The names of the images that this node can be provisioned as.

private List features

The list of the node's features.

private String id

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

private String image

The name of the image that this node is currently provisioned as.

private Map metrics

The node's reported metrics.

private String networkAddress

The node's network address.

private String partition

The node's partition.

private String pluginId

The ID of the plugin which has generated the report.

private NodeReportPower power

The current state of the node's power.

private ReportResourceMap resources

The job's resources information.

private NodeReportState state

The current state of the node.

private String substate

The node's current sub-state.

private Date timestamp

The date that the report was made or for which the report is current.

private Map variables

The node's variables.

 
Constructor Summary
NodeReport()

Creates a new, empty node report.

NodeReport(String id)

Creates a new node report for specified node.

 
Method Summary
String getArchitecture()

@see #architecture

List getAvailableImages()

@see #availableImages

List getFeatures()

@see #features

String getId()

@see #id

String getImage()

@see #image

Map getMetrics()

@see #metrics

String getNetworkAddress()

@see #networkAddress

String getPartition()

@see #partition

String getPluginId()

@see #pluginId

NodeReportPower getPower()

@see #power

ReportResourceMap getResources()

@see #resources

NodeReportState getState()

@see #state

String getSubstate()

@see #substate

Date getTimestamp()

Retrieves the set timestamp for the report.

Map getVariables()

@see #variables

void setArchitecture(String architecture)

@see #architecture

void setAvailableImages(List availableImages)

@see #availableImages

void setFeatures(List features)

@see #features

void setId(String id)

Sets the unique identifier for the node.

void setImage(String image)

Sets the image name for the node.

void setMetrics(Map metrics)

@see #metrics

void setNetworkAddress(String networkAddress)

@see #networkAddress

void setPartition(String partition)

@see #partition

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 setSubstate(String substate)

@see #substate

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

architecture

private String architecture
The node's architecture.


availableImages

private List availableImages
The names of the images that this node can be provisioned as. This relates to the image name in the MWS Image Catalog.


features

private List features
The list of the node's features.


id

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


image

private String image
The name of the image that this node is currently provisioned as. This relates to the image name in the MWS Image Catalog and hypervisor information (including available virtualized images) is pulled from the catalog and reported to Moab.


metrics

private Map metrics
The node's reported metrics.


networkAddress

private String networkAddress
The node's network address.


partition

private String partition
The node's partition.


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 current state of the node's power.


resources

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


state

private NodeReportState state
The current state of the node.


substate

private String substate
The node's current sub-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 node's variables.


 
Constructor Detail

NodeReport

public NodeReport()
Creates a new, empty node report.


NodeReport

public NodeReport(String id)
Creates a new node report for specified node.
Parameters:
id - See setId


 
Method Detail

getArchitecture

public String getArchitecture()
See Also:
architecture


getAvailableImages

public List getAvailableImages()
See Also:
availableImages


getFeatures

public List getFeatures()
See Also:
features


getId

public String getId()
See Also:
id


getImage

public String getImage()
See Also:
image


getMetrics

public Map getMetrics()
See Also:
metrics


getNetworkAddress

public String getNetworkAddress()
See Also:
networkAddress


getPartition

public String getPartition()
See Also:
partition


getPluginId

public String getPluginId()
See Also:
pluginId


getPower

public NodeReportPower getPower()
See Also:
power


getResources

public ReportResourceMap getResources()
See Also:
resources


getState

public NodeReportState getState()
See Also:
state


getSubstate

public String getSubstate()
See Also:
substate


getTimestamp

public Date getTimestamp()
Retrieves the set timestamp for the report. NOTE: If no timestamp is provided by the plugin, the timestamp will be assigned a value of the current date and time.
See Also:
timestamp


getVariables

public Map getVariables()
See Also:
variables


setArchitecture

public void setArchitecture(String architecture)
See Also:
architecture


setAvailableImages

public void setAvailableImages(List availableImages)
See Also:
availableImages


setFeatures

public void setFeatures(List features)
See Also:
features


setId

public void setId(String id)
Sets the unique identifier for the node. This automatically lower-cases the ID.
See Also:
id


setImage

public void setImage(String image)
Sets the image name for the node. This is used along with the MWS Image Catalog to retrieve hypervisor and supported virtual machine information.
See Also:
image


setMetrics

public void setMetrics(Map metrics)
See Also:
metrics


setNetworkAddress

public void setNetworkAddress(String networkAddress)
See Also:
networkAddress


setPartition

public void setPartition(String partition)
See Also:
partition


setPluginId

public void setPluginId(String pluginId)
Sets 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.
See Also:
pluginId


setPower

public void setPower(NodeReportPower power)
See Also:
power


setPower

public void setPower(String power)
Calls NodeReportPower.parse to set the power field.
See Also:
power


setResources

public void setResources(ReportResourceMap resources)
See Also:
resources


setState

public void setState(NodeReportState state)
See Also:
state


setState

public void setState(String state)
Calls NodeReportState.parse to set the state field.
See Also:
state


setSubstate

public void setSubstate(String substate)
See Also:
substate


setTimestamp

public void setTimestamp(Date timestamp)
See Also:
timestamp


setTimestamp

public void setTimestamp(String timestamp)
See Also:
timestamp


setVariables

public void setVariables(Map variables)
See Also:
variables


 

Groovy Documentation