AgentSnapshot

java.lang.Object
- agi.parallel.infrastructure.AgentSnapshot

All Implemented Interfaces:

java.io.Serializable
```
public class AgentSnapshot
extends java.lang.Object
implements java.io.Serializable
```
Represents the state of an agent.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AgentSnapshot()` Initializes a new instance of the `AgentSnapshot` class.
`AgentSnapshot(java.util.UUID id, boolean registered)` Initializes a new instance of the `AgentSnapshot` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActivity()` Gets the current activity performed on the agent.
`int`	`getCapacity()` Gets the capacity, which is the number of hosts that can be run simultaneously.
`int`	`getCpuSpeed()` Gets the cpu speed for the machine where the agent is running.
`int`	`getCurrentCpuUsage()` Gets the current cpu usage.
`java.util.GregorianCalendar`	`getDateStarted()` Gets the time that agent connected to coordinator.
`java.lang.String`	`getDescription()` Gets the description associated with this agent.
`int`	`getEstimatedMemoryBudget()` Gets the estimated memory budget, which is the amount of estimated memory budgeted to the agent.
`HardDiskStatus`	`getHardDisk()` Gets the amount of disk space on the drive the agent is running on.
`java.util.List<HostSnapshot>`	`getHostPool()` Gets the hostpool snapshot.
`java.util.UUID`	`getId()` Gets the agent identifier.
`boolean`	`getIsEnabled()` Gets a value indicating whether this agent is enabled or disabled.
`boolean`	`getIsRegistered()` Gets a value indicating whether this agent is registered.
`LoggingLevel`	`getLoggingLevel()` Gets the logging level of the agent.
`java.lang.String`	`getMachineName()` Gets the name of the machine where the agent is running.
`boolean`	`getMeetsThreshold()` Gets a value indicating whether the agent meets the threshold for agent selection that is set by the coordinator.
`MemoryStatus`	`getMemory()` Gets the memory status (i.e.
`NetworkStatus`	`getNetwork()` Gets the network activity that agent using for remote connections.
`OSPlatform`	`getOSPlatform()` Gets a value indicating what OS platform the agent is running on.
`int`	`getPriority()` Gets the current priority of the resource.
`java.util.Map<java.lang.String,java.lang.String>`	`getResources()` Gets the resources of the agent.
`java.util.Map<java.lang.String,java.lang.String>`	`getRuntimeProperties()` Gets the runtime properties of the agent.
`java.lang.String`	`getThresholdFailureReason()` Gets the reason for the threshold failure.
`java.util.GregorianCalendar`	`getTimeStamp()` Gets the time of snapshot creation.
`java.lang.String`	`getUserName()` Gets the name of the user of this agent.
`void`	`setActivity(java.lang.String value)` Sets the current activity performed on the agent.
`void`	`setCapacity(int value)` Sets the capacity, which is the number of hosts that can be run simultaneously.
`void`	`setCpuSpeed(int value)` Sets the cpu speed for the machine where the agent is running.
`void`	`setCurrentCpuUsage(int value)` Sets the current cpu usage.
`void`	`setDateStarted(java.util.GregorianCalendar value)` Sets the time that agent connected to coordinator.
`void`	`setDescription(java.lang.String value)` Sets the description associated with this agent.
`void`	`setEstimatedMemoryBudget(int value)` Sets the estimated memory budget, which is the amount of estimated memory budgeted to the agent.
`void`	`setHardDisk(HardDiskStatus value)` Sets the amount of disk space on the drive the agent is running on.
`void`	`setHostPool(java.util.List<HostSnapshot> value)` Sets the hostpool snapshot.
`void`	`setId(java.util.UUID value)` Sets the agent identifier.
`void`	`setIsEnabled(boolean value)` Sets a value indicating whether this agent is enabled or disabled.
`void`	`setIsRegistered(boolean value)` Sets a value indicating whether this agent is registered.
`void`	`setLoggingLevel(LoggingLevel value)` Sets the logging level of the agent.
`void`	`setMachineName(java.lang.String value)` Sets the name of the machine where the agent is running.
`void`	`setMeetsThreshold(boolean value)` Sets a value indicating whether the agent meets the threshold for agent selection that is set by the coordinator.
`void`	`setMemory(MemoryStatus value)` Sets the memory status (i.e.
`void`	`setNetwork(NetworkStatus value)` Sets the network activity that agent using for remote connections.
`void`	`setOSPlatform(OSPlatform value)` Sets a value indicating what OS platform the agent is running on.
`void`	`setPriority(int value)` Sets the current priority of the resource.
`void`	`setResources(java.util.Map<java.lang.String,java.lang.String> value)` Sets the resources of the agent.
`void`	`setRuntimeProperties(java.util.Map<java.lang.String,java.lang.String> value)` Sets the runtime properties of the agent.
`void`	`setThresholdFailureReason(java.lang.String value)` Sets the reason for the threshold failure.
`void`	`setTimeStamp(java.util.GregorianCalendar value)` Sets the time of snapshot creation.
`void`	`setUserName(java.lang.String value)` Sets the name of the user of this agent.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AgentSnapshot
```
public AgentSnapshot()
```
    Initializes a new instance of the AgentSnapshot class.
  - AgentSnapshot
```
public AgentSnapshot(java.util.UUID id,
                     boolean registered)
```
    Initializes a new instance of the AgentSnapshot class.
    
    Parameters:
    
    id - The agent identifier.
    
    registered - if set to true [registered].
- Method Detail
  - getMachineName
```
public final java.lang.String getMachineName()
```
    Gets the name of the machine where the agent is running.
    
    Returns:
    
    The name of the machine.
  - setMachineName
```
public final void setMachineName(java.lang.String value)
```
    Sets the name of the machine where the agent is running.
    
    Parameters:
    
    value - The name of the machine.
  - getLoggingLevel
```
public final LoggingLevel getLoggingLevel()
```
    Gets the logging level of the agent. The logging level.
  - setLoggingLevel
```
public final void setLoggingLevel(LoggingLevel value)
```
    Sets the logging level of the agent. The logging level.
  - getCpuSpeed
```
public final int getCpuSpeed()
```
    Gets the cpu speed for the machine where the agent is running. The cpu speed.
  - setCpuSpeed
```
public final void setCpuSpeed(int value)
```
    Sets the cpu speed for the machine where the agent is running. The cpu speed.
  - getCapacity
```
public final int getCapacity()
```
    Gets the capacity, which is the number of hosts that can be run simultaneously. The capacity.
  - setCapacity
```
public final void setCapacity(int value)
```
    Sets the capacity, which is the number of hosts that can be run simultaneously. The capacity.
  - getEstimatedMemoryBudget
```
public final int getEstimatedMemoryBudget()
```
    Gets the estimated memory budget, which is the amount of estimated memory budgeted to the agent. The estimated memory budget.
  - setEstimatedMemoryBudget
```
public final void setEstimatedMemoryBudget(int value)
```
    Sets the estimated memory budget, which is the amount of estimated memory budgeted to the agent. The estimated memory budget.
  - getMeetsThreshold
```
public final boolean getMeetsThreshold()
```
    Gets a value indicating whether the agent meets the threshold for agent selection that is set by the coordinator. true if meets threshold; otherwise, false.
  - setMeetsThreshold
```
public final void setMeetsThreshold(boolean value)
```
    Sets a value indicating whether the agent meets the threshold for agent selection that is set by the coordinator. true if meets threshold; otherwise, false.
  - getThresholdFailureReason
```
public final java.lang.String getThresholdFailureReason()
```
    Gets the reason for the threshold failure. If MeetsThreshold is false, this property should explain the reason for the threshold failure. The threshold failure reason.
  - setThresholdFailureReason
```
public final void setThresholdFailureReason(java.lang.String value)
```
    Sets the reason for the threshold failure. If MeetsThreshold is false, this property should explain the reason for the threshold failure. The threshold failure reason.
  - getActivity
```
public final java.lang.String getActivity()
```
    Gets the current activity performed on the agent. The current activity.
  - setActivity
```
public final void setActivity(java.lang.String value)
```
    Sets the current activity performed on the agent. The current activity.
  - getDescription
```
public final java.lang.String getDescription()
```
    Gets the description associated with this agent. The agent description.
  - setDescription
```
public final void setDescription(java.lang.String value)
```
    Sets the description associated with this agent. The agent description.
  - getId
```
public final java.util.UUID getId()
```
    Gets the agent identifier. The agent identifier.
  - setId
```
public final void setId(java.util.UUID value)
```
    Sets the agent identifier. The agent identifier.
  - getIsRegistered
```
public final boolean getIsRegistered()
```
    Gets a value indicating whether this agent is registered. true if this agent is registered; otherwise, false.
  - setIsRegistered
```
public final void setIsRegistered(boolean value)
```
    Sets a value indicating whether this agent is registered. true if this agent is registered; otherwise, false.
  - getIsEnabled
```
public final boolean getIsEnabled()
```
    Gets a value indicating whether this agent is enabled or disabled. true if this instance is enabled; otherwise, false.
  - setIsEnabled
```
public final void setIsEnabled(boolean value)
```
    Sets a value indicating whether this agent is enabled or disabled. true if this instance is enabled; otherwise, false.
  - getCurrentCpuUsage
```
public final int getCurrentCpuUsage()
```
    Gets the current cpu usage. The current cpu usage.
  - setCurrentCpuUsage
```
public final void setCurrentCpuUsage(int value)
```
    Sets the current cpu usage. The current cpu usage.
  - getMemory
```
public final MemoryStatus getMemory()
```
    Gets the memory status (i.e. total and available memory). The memory.
  - setMemory
```
public final void setMemory(MemoryStatus value)
```
    Sets the memory status (i.e. total and available memory). The memory.
  - getHardDisk
```
public final HardDiskStatus getHardDisk()
```
    Gets the amount of disk space on the drive the agent is running on. The disk space.
  - setHardDisk
```
public final void setHardDisk(HardDiskStatus value)
```
    Sets the amount of disk space on the drive the agent is running on. The disk space.
  - getNetwork
```
public final NetworkStatus getNetwork()
```
    Gets the network activity that agent using for remote connections. The network status.
  - setNetwork
```
public final void setNetwork(NetworkStatus value)
```
    Sets the network activity that agent using for remote connections. The network status.
  - getUserName
```
public final java.lang.String getUserName()
```
    Gets the name of the user of this agent. The user name.
  - setUserName
```
public final void setUserName(java.lang.String value)
```
    Sets the name of the user of this agent. The user name.
  - getPriority
```
public final int getPriority()
```
    Gets the current priority of the resource. Priority of the agent.
  - setPriority
```
public final void setPriority(int value)
```
    Sets the current priority of the resource. Priority of the agent.
  - getDateStarted
```
public final java.util.GregorianCalendar getDateStarted()
```
    Gets the time that agent connected to coordinator. The date started.
  - setDateStarted
```
public final void setDateStarted(java.util.GregorianCalendar value)
```
    Sets the time that agent connected to coordinator. The date started.
  - getTimeStamp
```
public final java.util.GregorianCalendar getTimeStamp()
```
    Gets the time of snapshot creation. The time stamp of the agent.
  - setTimeStamp
```
public final void setTimeStamp(java.util.GregorianCalendar value)
```
    Sets the time of snapshot creation. The time stamp of the agent.
  - getResources
```
public final java.util.Map<java.lang.String,java.lang.String> getResources()
```
    Gets the resources of the agent. The capabilities.
  - setResources
```
public final void setResources(java.util.Map<java.lang.String,java.lang.String> value)
```
    Sets the resources of the agent. The capabilities.
  - getRuntimeProperties
```
public final java.util.Map<java.lang.String,java.lang.String> getRuntimeProperties()
```
    Gets the runtime properties of the agent. The runtime properties.
  - setRuntimeProperties
```
public final void setRuntimeProperties(java.util.Map<java.lang.String,java.lang.String> value)
```
    Sets the runtime properties of the agent. The runtime properties.
  - getHostPool
```
public final java.util.List<HostSnapshot> getHostPool()
```
    Gets the hostpool snapshot. The list of host infos.
  - setHostPool
```
public final void setHostPool(java.util.List<HostSnapshot> value)
```
    Sets the hostpool snapshot. The list of host infos.
  - getOSPlatform
```
public final OSPlatform getOSPlatform()
```
    Gets a value indicating what OS platform the agent is running on.
  - setOSPlatform
```
public final void setOSPlatform(OSPlatform value)
```
    Sets a value indicating what OS platform the agent is running on.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AgentSnapshot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AgentSnapshot

AgentSnapshot

Method Detail

getMachineName

setMachineName

getLoggingLevel

setLoggingLevel

getCpuSpeed

setCpuSpeed

getCapacity

setCapacity

getEstimatedMemoryBudget

setEstimatedMemoryBudget

getMeetsThreshold

setMeetsThreshold

getThresholdFailureReason

setThresholdFailureReason

getActivity

setActivity

getDescription

setDescription

getId

setId

getIsRegistered

setIsRegistered

getIsEnabled

setIsEnabled

getCurrentCpuUsage

setCurrentCpuUsage

getMemory

setMemory

getHardDisk

setHardDisk

getNetwork

setNetwork

getUserName

setUserName

getPriority

setPriority

getDateStarted

setDateStarted

getTimeStamp

setTimeStamp

getResources

setResources

getRuntimeProperties

setRuntimeProperties

getHostPool

setHostPool

getOSPlatform

setOSPlatform

toString