Groovy Documentation

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

java.lang.Object
  com.adaptc.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 features

The list of the node's features.

private String image

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

private List imagesAvailable

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

private String ipAddress

The node's IPv4 address.

private List messages

A list of messages to attach to the node.

private Map metrics

The node's reported metrics.

private String name

The node's name.

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 Long precedence

The precedence of the plugin which has generated the report.

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 name)

Creates a new node report for specified node.

 
Method Summary
String getArchitecture()

@see #architecture

List getFeatures()

@see #features

String getImage()

@see #image

List getImagesAvailable()

@see #imagesAvailable

String getIpAddress()

@see #ipAddress

List getMessages()

@see #messages

Map getMetrics()

@see #metrics

String getName()

@see #name

String getPartition()

@see #partition

String getPluginId()

@see #pluginId

NodeReportPower getPower()

@see #power

Long getPrecedence()

@see #precedence

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 setFeatures(List features)

@see #features

void setImage(String image)

Sets the image name for the node.

void setImagesAvailable(List imagesAvailable)

@see #imagesAvailable

void setIpAddress(String ipAddress)

@see #ipAddress

void setMessages(List messages)

@see #messages

void setMetrics(Map metrics)

@see #metrics

void setName(String name)

Sets the unique identifier for the node.

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 setPrecedence(Long precedence)

Sets the precedence, corresponding to the precedence of the plugin which has generated the report.

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.


features

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


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.


imagesAvailable

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


ipAddress

private String ipAddress
The node's IPv4 address.


messages

private List messages
A list of messages to attach to the node. Double quotes (whether escaped or not) will be converted into single quotes.


metrics

private Map metrics
The node's reported metrics.


name

private String name
The node's name. This should be lower-case, but it will be converted automatically if it is not in setName(String).


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.


precedence

private Long precedence
The precedence 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.


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 name)
Creates a new node report for specified node.
Parameters:
name - See setName


 
Method Detail

getArchitecture

public String getArchitecture()
See Also:
architecture


getFeatures

public List getFeatures()
See Also:
features


getImage

public String getImage()
See Also:
image


getImagesAvailable

public List getImagesAvailable()
See Also:
imagesAvailable


getIpAddress

public String getIpAddress()
See Also:
ipAddress


getMessages

public List getMessages()
See Also:
messages


getMetrics

public Map getMetrics()
See Also:
metrics


getName

public String getName()
See Also:
name


getPartition

public String getPartition()
See Also:
partition


getPluginId

public String getPluginId()
See Also:
pluginId


getPower

public NodeReportPower getPower()
See Also:
power


getPrecedence

public Long getPrecedence()
See Also:
precedence


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


setFeatures

public void setFeatures(List features)
See Also:
features


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


setImagesAvailable

public void setImagesAvailable(List imagesAvailable)
See Also:
imagesAvailable


setIpAddress

public void setIpAddress(String ipAddress)
See Also:
ipAddress


setMessages

public void setMessages(List messages)
See Also:
messages


setMetrics

public void setMetrics(Map metrics)
See Also:
metrics


setName

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


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


setPrecedence

public void setPrecedence(Long precedence)
Sets the precedence, corresponding to the precedence 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:
precedence


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