Package org.ivoa.dm.execution

Class TransferPerformance

java.lang.Object
org.ivoa.dm.execution.TransferPerformance
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="execution:TransferPerformance", role=objectType) public class TransferPerformance extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Performance of data transfer to/from a node. objectType: TransferPerformance

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • fromLocation

      @VoDml(id="execution:TransferPerformance.fromLocation", role=reference, type="execution:PhysicalLocation", typeRole=objectType) protected PhysicalLocation fromLocation
      ReferenceObject fromLocation : the source location of the data transfer. ( Multiplicity : 1 )

    • throughput

      @VoDml(id="execution:TransferPerformance.throughput", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double throughput
      the throughput of the data transfer in bytes/second. : Attribute throughput type ivoa:real : multiplicity 1

    • latency

      @VoDml(id="execution:TransferPerformance.latency", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double latency
      the latency of the data transfer in seconds. : Attribute latency type ivoa:real : multiplicity 0..1

    • errorRate

      @VoDml(id="execution:TransferPerformance.errorRate", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double errorRate
      the error rate of the data transfer as a percentage. : Attribute errorRate type ivoa:real : multiplicity 0..1

    • timestamp

      @VoDml(id="execution:TransferPerformance.timestamp", role=attribute, type="ivoa:datetime", typeRole=primitiveType) protected Date timestamp
      the timestamp of the performance measurement. : Attribute timestamp type ivoa:datetime : multiplicity 1

  • Constructor Details

    • TransferPerformance

      public TransferPerformance()
      Creates a new TransferPerformance

    • TransferPerformance

      public TransferPerformance(PhysicalLocation fromLocation, Double throughput, Double latency, Double errorRate, Date timestamp)
      full parameter constructor.
      Parameters:
      fromLocation - the source location of the data transfer.
      throughput - the throughput of the data transfer in bytes/second.
      latency - the latency of the data transfer in seconds.
      errorRate - the error rate of the data transfer as a percentage.
      timestamp - the timestamp of the performance measurement.

    • TransferPerformance

      public TransferPerformance(TransferPerformance other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(TransferPerformance other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getFromLocation

      public PhysicalLocation getFromLocation()
      Returns fromLocation Reference
      Returns:
      fromLocation Reference

    • setFromLocation

      public void setFromLocation(PhysicalLocation pFromLocation)
      Defines fromLocation Reference
      Parameters:
      pFromLocation - reference to set

    • getThroughput

      public Double getThroughput()
      Returns throughput Attribute.
      Returns:
      throughput Attribute

    • setThroughput

      public void setThroughput(Double pThroughput)
      Set throughput Attribute.
      Parameters:
      pThroughput - value to set

    • withThroughput

      public TransferPerformance withThroughput(Double pThroughput)
      fluent setter for throughput Attribute.
      Parameters:
      pThroughput - value to set
      Returns:
      TransferPerformance

    • getLatency

      public Double getLatency()
      Returns latency Attribute.
      Returns:
      latency Attribute

    • setLatency

      public void setLatency(Double pLatency)
      Set latency Attribute.
      Parameters:
      pLatency - value to set

    • withLatency

      public TransferPerformance withLatency(Double pLatency)
      fluent setter for latency Attribute.
      Parameters:
      pLatency - value to set
      Returns:
      TransferPerformance

    • getErrorRate

      public Double getErrorRate()
      Returns errorRate Attribute.
      Returns:
      errorRate Attribute

    • setErrorRate

      public void setErrorRate(Double pErrorRate)
      Set errorRate Attribute.
      Parameters:
      pErrorRate - value to set

    • withErrorRate

      public TransferPerformance withErrorRate(Double pErrorRate)
      fluent setter for errorRate Attribute.
      Parameters:
      pErrorRate - value to set
      Returns:
      TransferPerformance

    • getTimestamp

      public Date getTimestamp()
      Returns timestamp Attribute.
      Returns:
      timestamp Attribute

    • setTimestamp

      public void setTimestamp(Date pTimestamp)
      Set timestamp Attribute.
      Parameters:
      pTimestamp - value to set

    • withTimestamp

      public TransferPerformance withTimestamp(Date pTimestamp)
      fluent setter for timestamp Attribute.
      Parameters:
      pTimestamp - value to set
      Returns:
      TransferPerformance

    • createTransferPerformance

      public static TransferPerformance createTransferPerformance(Consumer<TransferPerformance.TransferPerformanceBuilder> f)
      create a TransferPerformance in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>