com.appiancorp.suiteapi.process.analytics2

Class PerformanceMetrics

java.lang.Object

com.appiancorp.suiteapi.process.analytics2.PerformanceMetrics

All Implemented Interfaces:

java.io.Serializable

public class PerformanceMetrics
extends java.lang.Object
implements java.io.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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PerformanceMetrics()

Method Summary

Modifier and Type	Method and Description
java.sql.Timestamp	getExecutionTimestamp() Gets the timestamp when the performance metrics was generated for the report.
double	getMaximumReportTime() Returns the maximum time allowed for generating the report in the shard.
double	getMaximumReportTimeMain() Returns the maximum time allowed for generating the report.
double	getMaximumReportTimeMaster() Deprecated. use getMaximumReportTimeMain() instead
PerformanceAttributes[]	getPerformanceAttributes() Returns an array of performance attributes that were applied during report generation.
java.lang.String	getReportName() Returns the name of the report for which the performance metrics belong to.
double	getTotalTime() Returns the total time taken to generate the report.
java.lang.String	getUsername() Returns the name of the user that executed the report
int	incrementOrder() Returns the next order integer value to be used.
void	setExecutionTimestamp(java.sql.Timestamp executionTimestamp_) Sets the timestamp of PerformanceMetrics/report generation in the shard.
void	setMaximumReportTime(double maximumReportTime_) Sets the maximum time allowed for generating the report.
void	setMaximumReportTimeMain(double maximumReportTimeMain_) Sets the maximum time allowed for generating the report.
void	setMaximumReportTimeMaster(double maximumReportTimeMain_) Deprecated. use setMaximumReportTimeMain(double) instead
void	setOrder(java.util.concurrent.atomic.AtomicInteger order)
void	setPerformanceAttributes(PerformanceAttributes[] performanceAttributes_)
void	setReportName(java.lang.String reportName_)
void	setTotalTime(double totalTime_)
void	setUsername(java.lang.String username_)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PerformanceMetrics

public PerformanceMetrics()

Method Detail

getExecutionTimestamp

public java.sql.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(java.sql.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:

getPerformanceAttributes()

getReportName

public java.lang.String getReportName()

Returns the name of the report for which the performance metrics belong to.

setReportName

public void setReportName(java.lang.String reportName_)

See Also:

getReportName()

getTotalTime

public double getTotalTime()

Returns the total time taken to generate the report.

setTotalTime

public void setTotalTime(double totalTime_)

See Also:

getTotalTime()

getUsername

public java.lang.String getUsername()

Returns the name of the user that executed the report

setUsername

public void setUsername(java.lang.String username_)

See Also:

getUsername()

incrementOrder

public int incrementOrder()

Returns the next order integer value to be used.

Returns:

setOrder

public void setOrder(java.util.concurrent.atomic.AtomicInteger order)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object