Package com.stripe.model.reporting

Class ReportType

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.reporting.ReportType

All Implemented Interfaces:

HasId, StripeObjectInterface

public class ReportType
extends ApiResource
implements HasId

Nested Class Summary

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
ReportType()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.Long	getDataAvailableEnd()	Most recent time for which this Report Type is available.
java.lang.Long	getDataAvailableStart()	Earliest time for which this Report Type is available.
java.util.List<java.lang.String>	getDefaultColumns()	List of column names that are included by default when this Report Type gets run.
java.lang.String	getId()	The ID of the Report Type, such as balance.summary.1.
java.lang.Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
java.lang.String	getName()	Human-readable name of the Report Type.
java.lang.String	getObject()	String representing the object's type.
java.lang.Long	getUpdated()	When this Report Type was latest updated.
java.lang.Long	getVersion()	Version of the Report Type.
int	hashCode()
static ReportTypeCollection	list(ReportTypeListParams params)	Returns a full list of Report Types.
static ReportTypeCollection	list(ReportTypeListParams params, RequestOptions options)	Returns a full list of Report Types.
static ReportTypeCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	Returns a full list of Report Types.
static ReportTypeCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Returns a full list of Report Types.
static ReportType	retrieve(java.lang.String reportType)	Retrieves the details of a Report Type.
static ReportType	retrieve(java.lang.String reportType, RequestOptions options)	Retrieves the details of a Report Type.
static ReportType	retrieve(java.lang.String reportType, ReportTypeRetrieveParams params, RequestOptions options)	Retrieves the details of a Report Type.
static ReportType	retrieve(java.lang.String reportType, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieves the details of a Report Type.
void	setDataAvailableEnd(java.lang.Long dataAvailableEnd)	Most recent time for which this Report Type is available.
void	setDataAvailableStart(java.lang.Long dataAvailableStart)	Earliest time for which this Report Type is available.
void	setDefaultColumns(java.util.List<java.lang.String> defaultColumns)	List of column names that are included by default when this Report Type gets run.
void	setId(java.lang.String id)	The ID of the Report Type, such as balance.summary.1.
void	setLivemode(java.lang.Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setName(java.lang.String name)	Human-readable name of the Report Type.
void	setObject(java.lang.String object)	String representing the object's type.
void	setUpdated(java.lang.Long updated)	When this Report Type was latest updated.
void	setVersion(java.lang.Long version)	Version of the Report Type.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportType

public ReportType()

Method Detail

retrieve

public static ReportType retrieve(java.lang.String reportType)
                           throws StripeException

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Throws:

StripeException

retrieve

public static ReportType retrieve(java.lang.String reportType,
                                  RequestOptions options)
                           throws StripeException

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Throws:

StripeException

retrieve

public static ReportType retrieve(java.lang.String reportType,
                                  java.util.Map<java.lang.String,java.lang.Object> params,
                                  RequestOptions options)
                           throws StripeException

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Throws:

StripeException

retrieve

public static ReportType retrieve(java.lang.String reportType,
                                  ReportTypeRetrieveParams params,
                                  RequestOptions options)
                           throws StripeException

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Throws:

StripeException

list

public static ReportTypeCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                 throws StripeException

Returns a full list of Report Types.

Throws:

StripeException

list

public static ReportTypeCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                        RequestOptions options)
                                 throws StripeException

Returns a full list of Report Types.

Throws:

StripeException

list

public static ReportTypeCollection list(ReportTypeListParams params)
                                 throws StripeException

Returns a full list of Report Types.

Throws:

StripeException

list

public static ReportTypeCollection list(ReportTypeListParams params,
                                        RequestOptions options)
                                 throws StripeException

Returns a full list of Report Types.

Throws:

StripeException

getDataAvailableEnd

public java.lang.Long getDataAvailableEnd()

Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

getDataAvailableStart

public java.lang.Long getDataAvailableStart()

Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

getDefaultColumns

public java.util.List<java.lang.String> getDefaultColumns()

List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)

getLivemode

public java.lang.Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getName

public java.lang.String getName()

Human-readable name of the Report Type.

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_type.

getUpdated

public java.lang.Long getUpdated()

When this Report Type was latest updated. Measured in seconds since the Unix epoch.

getVersion

public java.lang.Long getVersion()

Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.

setDataAvailableEnd

public void setDataAvailableEnd(java.lang.Long dataAvailableEnd)

Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

setDataAvailableStart

public void setDataAvailableStart(java.lang.Long dataAvailableStart)

Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

setDefaultColumns

public void setDefaultColumns(java.util.List<java.lang.String> defaultColumns)

List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)

setId

public void setId(java.lang.String id)

The ID of the Report Type, such as balance.summary.1.

setLivemode

public void setLivemode(java.lang.Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setName

public void setName(java.lang.String name)

Human-readable name of the Report Type.

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_type.

setUpdated

public void setUpdated(java.lang.Long updated)

When this Report Type was latest updated. Measured in seconds since the Unix epoch.

setVersion

public void setVersion(java.lang.Long version)

Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

The ID of the Report Type, such as balance.summary.1.

Specified by:

getId in interface HasId