public class ReportRun extends ApiResource implements HasId
Modifier and Type | Class and Description |
---|---|
static class |
ReportRun.Parameters |
ApiResource.RequestMethod
CHARSET, GSON
PRETTY_PRINT_GSON
Constructor and Description |
---|
ReportRun() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canEqual(java.lang.Object other) |
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.
|
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.
|
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 when
status=failed ). |
java.lang.String |
getId()
Unique identifier for the object.
|
java.lang.Boolean |
getLivemode()
Always
true : reports can only be run on live-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 when
status=succeeded ). |
java.lang.String |
getStatus()
Status of this report run.
|
java.lang.Long |
getSucceededAt()
Timestamp at which this run successfully finished (populated when
status=succeeded ). |
int |
hashCode() |
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 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 ReportRun |
retrieve(java.lang.String reportRun)
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.
|
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,
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 when
status=failed ). |
void |
setId(java.lang.String id)
Unique identifier for the object.
|
void |
setLivemode(java.lang.Boolean livemode)
Always
true : reports can only be run on live-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 when
status=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 when
status=succeeded ). |
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
public static ReportRun retrieve(java.lang.String reportRun) throws StripeException
StripeException
public static ReportRun retrieve(java.lang.String reportRun, RequestOptions options) throws StripeException
StripeException
public static ReportRun retrieve(java.lang.String reportRun, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static ReportRun retrieve(java.lang.String reportRun, ReportRunRetrieveParams params, RequestOptions options) throws StripeException
StripeException
public static ReportRun create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public static ReportRun create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static ReportRun create(ReportRunCreateParams params) throws StripeException
StripeException
public static ReportRun create(ReportRunCreateParams params, RequestOptions options) throws StripeException
StripeException
public static ReportRunCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public static ReportRunCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static ReportRunCollection list(ReportRunListParams params) throws StripeException
StripeException
public static ReportRunCollection list(ReportRunListParams params, RequestOptions options) throws StripeException
StripeException
public java.lang.Long getCreated()
public java.lang.String getError()
status=failed
).public java.lang.Boolean getLivemode()
true
: reports can only be run on live-mode data.public java.lang.String getObject()
Equal to reporting.report_run
.
public ReportRun.Parameters getParameters()
public java.lang.String getReportType()
"balance.summary.1"
.public File getResult()
status=succeeded
).public java.lang.String getStatus()
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.public java.lang.Long getSucceededAt()
status=succeeded
).
Measured in seconds since the Unix epoch.public void setCreated(java.lang.Long created)
public void setError(java.lang.String error)
status=failed
).public void setId(java.lang.String id)
public void setLivemode(java.lang.Boolean livemode)
true
: reports can only be run on live-mode data.public void setObject(java.lang.String object)
Equal to reporting.report_run
.
public void setParameters(ReportRun.Parameters parameters)
public void setReportType(java.lang.String reportType)
"balance.summary.1"
.public void setResult(File result)
status=succeeded
).public void setStatus(java.lang.String status)
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.public void setSucceededAt(java.lang.Long succeededAt)
status=succeeded
).
Measured in seconds since the Unix epoch.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object