Package com.inductiveautomation.reporting.common.resource

Record Class ReportCompletionDetails

java.lang.Object
java.lang.Record
com.inductiveautomation.reporting.common.resource.ReportCompletionDetails
Record Components:
projectName - The name of the project.
reportPath - The path to the report.
completionDate - The date and time the report completed.
isScheduledRun - Whether this was a scheduled run.
public record ReportCompletionDetails(String projectName, String reportPath, Date completionDate, boolean isScheduledRun) extends Record
Used to let the Gateway send a push notification to projects when the report completes execution.

  • Constructor Details

    • ReportCompletionDetails

      public ReportCompletionDetails(String projectName, String reportPath, Date completionDate, boolean isScheduledRun)
      Creates an instance of a ReportCompletionDetails record class.
      Parameters:
      projectName - the value for the projectName record component
      reportPath - the value for the reportPath record component
      completionDate - the value for the completionDate record component
      isScheduledRun - the value for the isScheduledRun record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • projectName

      public String projectName()
      Returns the value of the projectName record component.
      Returns:
      the value of the projectName record component

    • reportPath

      public String reportPath()
      Returns the value of the reportPath record component.
      Returns:
      the value of the reportPath record component

    • completionDate

      public Date completionDate()
      Returns the value of the completionDate record component.
      Returns:
      the value of the completionDate record component

    • isScheduledRun

      public boolean isScheduledRun()
      Returns the value of the isScheduledRun record component.
      Returns:
      the value of the isScheduledRun record component