Package com.stripe.model.reporting
Class ReportRun
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.reporting.ReportRun
-
- All Implemented Interfaces:
HasId
,StripeObjectInterface
public class ReportRun extends ApiResource implements HasId
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ReportRun.Parameters
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description ReportRun()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.Object other)
static ReportRun
create(ReportRunCreateParams params)
Creates a new object and begin running the report.static ReportRun
create(ReportRunCreateParams params, RequestOptions options)
Creates a new object and begin running the report.static ReportRun
create(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a new object and begin running the report.static ReportRun
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Creates a new object and begin running the report.boolean
equals(java.lang.Object o)
java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getError()
If something should go wrong during the run, a message about the failure (populated whenstatus=failed
).java.lang.String
getId()
Unique identifier for the object.java.lang.Boolean
getLivemode()
true
if the report is run on live mode data andfalse
if it is run on test mode data.java.lang.String
getObject()
String representing the object's type.ReportRun.Parameters
getParameters()
java.lang.String
getReportType()
The ID of the report type to run, such as"balance.summary.1"
.File
getResult()
The file object representing the result of the report run (populated whenstatus=succeeded
).java.lang.String
getStatus()
Status of this report run.java.lang.Long
getSucceededAt()
Timestamp at which this run successfully finished (populated whenstatus=succeeded
).int
hashCode()
static ReportRunCollection
list(ReportRunListParams params)
Returns a list of Report Runs, with the most recent appearing first.static ReportRunCollection
list(ReportRunListParams params, RequestOptions options)
Returns a list of Report Runs, with the most recent appearing first.static ReportRunCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of Report Runs, with the most recent appearing first.static ReportRunCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of Report Runs, with the most recent appearing first.static ReportRun
retrieve(java.lang.String reportRun)
Retrieves the details of an existing Report Run.static ReportRun
retrieve(java.lang.String reportRun, RequestOptions options)
Retrieves the details of an existing Report Run.static ReportRun
retrieve(java.lang.String reportRun, ReportRunRetrieveParams params, RequestOptions options)
Retrieves the details of an existing Report Run.static ReportRun
retrieve(java.lang.String reportRun, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the details of an existing Report Run.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setError(java.lang.String error)
If something should go wrong during the run, a message about the failure (populated whenstatus=failed
).void
setId(java.lang.String id)
Unique identifier for the object.void
setLivemode(java.lang.Boolean livemode)
true
if the report is run on live mode data andfalse
if it is run on test mode data.void
setObject(java.lang.String object)
String representing the object's type.void
setParameters(ReportRun.Parameters parameters)
void
setReportType(java.lang.String reportType)
The ID of the report type to run, such as"balance.summary.1"
.void
setResult(File result)
The file object representing the result of the report run (populated whenstatus=succeeded
).void
setStatus(java.lang.String status)
Status of this report run.void
setSucceededAt(java.lang.Long succeededAt)
Timestamp at which this run successfully finished (populated whenstatus=succeeded
).-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
retrieve
public static ReportRun retrieve(java.lang.String reportRun) throws StripeException
Retrieves the details of an existing Report Run.- Throws:
StripeException
-
retrieve
public static ReportRun retrieve(java.lang.String reportRun, RequestOptions options) throws StripeException
Retrieves the details of an existing Report Run.- Throws:
StripeException
-
retrieve
public static ReportRun retrieve(java.lang.String reportRun, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the details of an existing Report Run.- Throws:
StripeException
-
retrieve
public static ReportRun retrieve(java.lang.String reportRun, ReportRunRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the details of an existing Report Run.- Throws:
StripeException
-
create
public static ReportRun create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)- Throws:
StripeException
-
create
public static ReportRun create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)- Throws:
StripeException
-
create
public static ReportRun create(ReportRunCreateParams params) throws StripeException
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)- Throws:
StripeException
-
create
public static ReportRun create(ReportRunCreateParams params, RequestOptions options) throws StripeException
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)- Throws:
StripeException
-
list
public static ReportRunCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of Report Runs, with the most recent appearing first.- Throws:
StripeException
-
list
public static ReportRunCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of Report Runs, with the most recent appearing first.- Throws:
StripeException
-
list
public static ReportRunCollection list(ReportRunListParams params) throws StripeException
Returns a list of Report Runs, with the most recent appearing first.- Throws:
StripeException
-
list
public static ReportRunCollection list(ReportRunListParams params, RequestOptions options) throws StripeException
Returns a list of Report Runs, with the most recent appearing first.- Throws:
StripeException
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getError
public java.lang.String getError()
If something should go wrong during the run, a message about the failure (populated whenstatus=failed
).
-
getLivemode
public java.lang.Boolean getLivemode()
true
if the report is run on live mode data andfalse
if it is run on test mode data.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
reporting.report_run
.
-
getParameters
public ReportRun.Parameters getParameters()
-
getReportType
public java.lang.String getReportType()
The ID of the report type to run, such as"balance.summary.1"
.
-
getResult
public File getResult()
The file object representing the result of the report run (populated whenstatus=succeeded
).
-
getStatus
public java.lang.String getStatus()
Status of this report run. This will bepending
when the run is initially created. When the run finishes, this will be set tosucceeded
and theresult
field will be populated. Rarely, we may encounter an error, at which point this will be set tofailed
and theerror
field will be populated.
-
getSucceededAt
public java.lang.Long getSucceededAt()
Timestamp at which this run successfully finished (populated whenstatus=succeeded
). Measured in seconds since the Unix epoch.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setError
public void setError(java.lang.String error)
If something should go wrong during the run, a message about the failure (populated whenstatus=failed
).
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
true
if the report is run on live mode data andfalse
if it is run on test mode data.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
reporting.report_run
.
-
setParameters
public void setParameters(ReportRun.Parameters parameters)
-
setReportType
public void setReportType(java.lang.String reportType)
The ID of the report type to run, such as"balance.summary.1"
.
-
setResult
public void setResult(File result)
The file object representing the result of the report run (populated whenstatus=succeeded
).
-
setStatus
public void setStatus(java.lang.String status)
Status of this report run. This will bepending
when the run is initially created. When the run finishes, this will be set tosucceeded
and theresult
field will be populated. Rarely, we may encounter an error, at which point this will be set tofailed
and theerror
field will be populated.
-
setSucceededAt
public void setSucceededAt(java.lang.Long succeededAt)
Timestamp at which this run successfully finished (populated whenstatus=succeeded
). Measured in seconds since the Unix epoch.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-