UpdateHeartbeatMessage (Atlassian Bamboo 9.5.1 API)

java.lang.Object
- com.atlassian.bamboo.v2.build.agent.messages.AbstractBambooAgentMessage
- - com.atlassian.bamboo.v2.build.agent.messages.UpdateHeartbeatMessage

All Implemented Interfaces:

BambooAgentMessage, Serializable
```
public class UpdateHeartbeatMessage
extends AbstractBambooAgentMessage
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`UpdateHeartbeatMessage(@NotNull Long agentId, @NotNull AgentStatus status, @NotNull SystemInfo systemInfo, @Nullable UUID uuid)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`deliver()`	Delivers the message to the appropriate object in the local virtual machine.
`boolean`	`shouldBeSentDuringHeartAttack()`	Value of true indicates that the message send should be attempted even if the agent is in "heart attack" state.

Methods inherited from class com.atlassian.bamboo.v2.build.agent.messages.AbstractBambooAgentMessage
getComponent

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

- Constructor Detail
  - UpdateHeartbeatMessage
```
public UpdateHeartbeatMessage(@NotNull
                              @NotNull Long agentId,
                              @NotNull
                              @NotNull AgentStatus status,
                              @NotNull
                              @NotNull SystemInfo systemInfo,
                              @Nullable
                              @Nullable UUID uuid)
```
- Method Detail
  - deliver
```
public Object deliver()
```
    Description copied from interface: BambooAgentMessage
    
    Delivers the message to the appropriate object in the local virtual machine.
    
    Returns:
    
    an optional reply to message (including error-reporting messages)
  - shouldBeSentDuringHeartAttack
```
public boolean shouldBeSentDuringHeartAttack()
```
    Description copied from interface: BambooAgentMessage
    
    Value of true indicates that the message send should be attempted even if the agent is in "heart attack" state. "Heart attack" state means that heartbeat timeout has been exceeded, but the agent is still running with limited functionality in order to give itself a chance of finishing current build/deployment and returning its result should the communication be re-established.