Struct ReportingReportRun

pub struct ReportingReportRun {
    pub created: Timestamp,
    pub error: Option<String>,
    pub id: ReportingReportRunId,
    pub livemode: bool,
    pub parameters: FinancialReportingFinanceReportRunRunParameters,
    pub report_type: String,
    pub result: Option<File>,
    pub status: String,
    pub succeeded_at: Option<Timestamp>,
}

The Report Run object represents an instance of a report type 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 a file where you can retrieve your results. For an overview, see API Access to Reports.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

For more details see <https://stripe.com/docs/api/reporting/report_run/object>.

Fields

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

error: Option<String>

If something should go wrong during the run, a message about the failure (populated when status=failed).

id: ReportingReportRunId

Unique identifier for the object.

livemode: bool

true if the report is run on live mode data and false if it is run on test mode data.

parameters: FinancialReportingFinanceReportRunRunParameters

report_type: String

The ID of the report type to run, such as "balance.summary.1".

result: Option<File>

The file object representing the result of the report run (populated when status=succeeded).

status: String

Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.

succeeded_at: Option<Timestamp>

Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.

Trait Implementations

impl Clone for ReportingReportRun

fn clone(&self) -> ReportingReportRun

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReportingReportRun

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for ReportingReportRun

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for ReportingReportRun

fn from_value(v: Value) -> Option<Self>

impl Object for ReportingReportRun

type Id = ReportingReportRunId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for ReportingReportRun

type Builder = ReportingReportRunBuilder