Class HeartbeatResponse

java.lang.Object
com.blockchyp.client.dto.HeartbeatResponse
All Implemented Interfaces:
IAbstractAcknowledgement

public class HeartbeatResponse extends Object implements IAbstractAcknowledgement
The response to a basic API health check. If the security context permits it, the response may also include the public key of the current merchant.
  • Constructor Details

    • HeartbeatResponse

      public HeartbeatResponse()
  • Method Details

    • setSuccess

      public void setSuccess(boolean value)
      Sets whether or not the request succeeded.
      Parameters:
      value - whether or not the request succeeded.
    • isSuccess

      public boolean isSuccess()
      Gets whether or not the request succeeded.
      Specified by:
      isSuccess in interface IAbstractAcknowledgement
      Returns:
      whether or not the request succeeded.
    • setError

      public void setError(String value)
      Sets the error, if an error occurred.
      Parameters:
      value - the error, if an error occurred.
    • getError

      public String getError()
      Gets the error, if an error occurred.
      Specified by:
      getError in interface IAbstractAcknowledgement
      Returns:
      the error, if an error occurred.
    • setResponseDescription

      public void setResponseDescription(String value)
      Sets a narrative description of the transaction result.
      Parameters:
      value - a narrative description of the transaction result.
    • getResponseDescription

      public String getResponseDescription()
      Gets a narrative description of the transaction result.
      Specified by:
      getResponseDescription in interface IAbstractAcknowledgement
      Returns:
      a narrative description of the transaction result.
    • setTimestamp

      public void setTimestamp(Date value)
      Sets the timestamp of the heartbeat.
      Parameters:
      value - the timestamp of the heartbeat.
    • getTimestamp

      public Date getTimestamp()
      Gets the timestamp of the heartbeat.
      Returns:
      the timestamp of the heartbeat.
    • setClockchain

      public void setClockchain(String value)
      Sets the public key of the clockchain.
      Parameters:
      value - the public key of the clockchain. This is blockchain stuff that you don't really need to worry about. It is a base 58 encoded and compressed eliptic curve public key. For the production clockchain, this will always be: '3cuhsckVUd9HzMjbdUSW17aY5kCcm1d6YAphJMUwmtXRj7WLyU'.
    • getClockchain

      public String getClockchain()
      Gets the public key of the clockchain.
      Returns:
      the public key of the clockchain. This is blockchain stuff that you don't really need to worry about. It is a base 58 encoded and compressed eliptic curve public key. For the production clockchain, this will always be: '3cuhsckVUd9HzMjbdUSW17aY5kCcm1d6YAphJMUwmtXRj7WLyU'.
    • setLatestTick

      public void setLatestTick(String value)
      Sets the hash of the last tick block.
      Parameters:
      value - the hash of the last tick block.
    • getLatestTick

      public String getLatestTick()
      Gets the hash of the last tick block.
      Returns:
      the hash of the last tick block.
    • setMerchantPublicKey

      public void setMerchantPublicKey(String value)
      Sets the public key for the merchant's blockchain.
      Parameters:
      value - the public key for the merchant's blockchain.
    • getMerchantPublicKey

      public String getMerchantPublicKey()
      Gets the public key for the merchant's blockchain.
      Returns:
      the public key for the merchant's blockchain.