Package com.stripe.model.v2.reporting

Class ReportRun

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.reporting.ReportRun
All Implemented Interfaces:
HasId, StripeObjectInterface
public class ReportRun extends StripeObject implements HasId
The ReportRun object represents an instance of a Report generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to the results.

  • Constructor Details

    • ReportRun

      public ReportRun()

  • Method Details

    • getCreated

      public Instant getCreated()
      Time at which the object was created.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.reporting.report_run.

    • getReport

      public String getReport()
      The unique identifier of the Report object which was run.

    • getReportName

      public String getReportName()
      The human-readable name of the Report which was run.

    • getReportParameters

      public Map<String,Object> getReportParameters()
      The parameters used to customize the generation of the report.

    • getResult

      public ReportRun.Result getResult()
      Details how to retrieve the results of a successfully completed ReportRun.

    • getResultOptions

      public ReportRun.ResultOptions getResultOptions()
      The options specified for customizing the output file of the ReportRun.

    • getStatus

      public String getStatus()
      The current status of the ReportRun.

      One of failed, running, or succeeded.

    • getStatusDetails

      public Map<String,ReportRun.StatusDetail> getStatusDetails()
      Additional details about the current state of the ReportRun. The field is currently only populated when a ReportRun is in the failed state, providing more information about why the report failed to generate successfully.

    • setCreated

      public void setCreated(Instant created)
      Time at which the object was created.

    • setId

      public void setId(String id)
      The unique identifier of the ReportRun object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.reporting.report_run.

    • setReport

      public void setReport(String report)
      The unique identifier of the Report object which was run.

    • setReportName

      public void setReportName(String reportName)
      The human-readable name of the Report which was run.

    • setReportParameters

      public void setReportParameters(Map<String,Object> reportParameters)
      The parameters used to customize the generation of the report.

    • setResult

      public void setResult(ReportRun.Result result)
      Details how to retrieve the results of a successfully completed ReportRun.

    • setResultOptions

      public void setResultOptions(ReportRun.ResultOptions resultOptions)
      The options specified for customizing the output file of the ReportRun.

    • setStatus

      public void setStatus(String status)
      The current status of the ReportRun.

      One of failed, running, or succeeded.

    • setStatusDetails

      public void setStatusDetails(Map<String,ReportRun.StatusDetail> statusDetails)
      Additional details about the current state of the ReportRun. The field is currently only populated when a ReportRun is in the failed state, providing more information about why the report failed to generate successfully.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      The unique identifier of the ReportRun object.
      Specified by:
      getId in interface HasId