Package com.appiancorp.suiteapi.process.analytics2

Class PerformanceMetrics

java.lang.Object
com.appiancorp.suiteapi.process.analytics2.PerformanceMetrics
All Implemented Interfaces:
Serializable
public class PerformanceMetrics extends Object implements Serializable
This object represents the metrics for the generated report. It contains an array of PerformanceAttributes that are executed while generating the report. The object contains various timings related to the generation of the report.
See Also:

  • Constructor Details

    • PerformanceMetrics

      public PerformanceMetrics()

  • Method Details

    • getExecutionTimestamp

      public Timestamp getExecutionTimestamp()
      Gets the timestamp when the performance metrics was generated for the report. This is same as time when report was generated.

    • setExecutionTimestamp

      public void setExecutionTimestamp(Timestamp executionTimestamp_)
      Sets the timestamp of PerformanceMetrics/report generation in the shard.

    • getMaximumReportTime

      public double getMaximumReportTime()
      Returns the maximum time allowed for generating the report in the shard.

    • setMaximumReportTime

      public void setMaximumReportTime(double maximumReportTime_)
      Sets the maximum time allowed for generating the report.

    • getMaximumReportTimeMaster

      @Deprecated public double getMaximumReportTimeMaster()
      Deprecated.
      use getMaximumReportTimeMain() instead
      Returns the maximum time allowed for generating the report.

    • getMaximumReportTimeMain

      public double getMaximumReportTimeMain()
      Returns the maximum time allowed for generating the report.

    • setMaximumReportTimeMaster

      @Deprecated public void setMaximumReportTimeMaster(double maximumReportTimeMain_)
      Deprecated.
      use setMaximumReportTimeMain(double) instead
      Sets the maximum time allowed for generating the report.

    • setMaximumReportTimeMain

      public void setMaximumReportTimeMain(double maximumReportTimeMain_)
      Sets the maximum time allowed for generating the report.

    • getPerformanceAttributes

      public PerformanceAttributes[] getPerformanceAttributes()
      Returns an array of performance attributes that were applied during report generation.

    • setPerformanceAttributes

      public void setPerformanceAttributes(PerformanceAttributes[] performanceAttributes_)
      See Also:

    • getReportName

      public String getReportName()
      Returns the name of the report for which the performance metrics belong to.

    • setReportName

      public void setReportName(String reportName_)
      See Also:

    • getTotalTime

      public double getTotalTime()
      Returns the total time taken to generate the report.

    • setTotalTime

      public void setTotalTime(double totalTime_)
      See Also:

    • getUsername

      public String getUsername()
      Returns the name of the user that executed the report

    • setUsername

      public void setUsername(String username_)
      See Also:

    • incrementOrder

      public int incrementOrder()
      Returns the next order integer value to be used.
      Returns:

    • setOrder

      public void setOrder(AtomicInteger order)

    • toString

      public String toString()
      Overrides:
      toString in class Object