Package com.stripe.model
Class Event
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.Event
-
- All Implemented Interfaces:
HasId
,StripeObjectInterface
public class Event 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 Event()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.Object other)
boolean
equals(java.lang.Object o)
java.lang.String
getAccount()
The connected account that originated the event.java.lang.String
getApiVersion()
The Stripe API version used to renderdata
.java.lang.Long
getCreated()
Time at which the object was created.EventData
getData()
EventDataObjectDeserializer
getDataObjectDeserializer()
Get deserialization helper to handle failure due to schema incompatibility.java.lang.String
getId()
Unique identifier for the object.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.lang.String
getObject()
String representing the object's type.java.lang.Long
getPendingWebhooks()
Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.EventRequest
getRequest()
Information on the API request that instigated the event.java.lang.String
getType()
Description of the event (e.g.,invoice.created
orcharge.refunded
).int
hashCode()
static EventCollection
list(EventListParams params)
List events, going back up to 30 days.static EventCollection
list(EventListParams params, RequestOptions options)
List events, going back up to 30 days.static EventCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
List events, going back up to 30 days.static EventCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
List events, going back up to 30 days.static Event
retrieve(java.lang.String id)
Retrieves the details of an event.static Event
retrieve(java.lang.String id, RequestOptions options)
Retrieves the details of an event.static Event
retrieve(java.lang.String id, EventRetrieveParams params, RequestOptions options)
Retrieves the details of an event.static Event
retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the details of an event.void
setAccount(java.lang.String account)
The connected account that originated the event.void
setApiVersion(java.lang.String apiVersion)
The Stripe API version used to renderdata
.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setData(EventData data)
void
setId(java.lang.String id)
Unique identifier for the object.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setObject(java.lang.String object)
String representing the object's type.void
setPendingWebhooks(java.lang.Long pendingWebhooks)
Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.void
setRequest(EventRequest request)
Information on the API request that instigated the event.void
setType(java.lang.String type)
Description of the event (e.g.,invoice.created
orcharge.refunded
).-
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
-
-
-
-
Method Detail
-
list
public static EventCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event objectapi_version
attribute (not according to your current Stripe API version orStripe-Version
header).- Throws:
StripeException
-
list
public static EventCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event objectapi_version
attribute (not according to your current Stripe API version orStripe-Version
header).- Throws:
StripeException
-
list
public static EventCollection list(EventListParams params) throws StripeException
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event objectapi_version
attribute (not according to your current Stripe API version orStripe-Version
header).- Throws:
StripeException
-
list
public static EventCollection list(EventListParams params, RequestOptions options) throws StripeException
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event objectapi_version
attribute (not according to your current Stripe API version orStripe-Version
header).- Throws:
StripeException
-
retrieve
public static Event retrieve(java.lang.String id) throws StripeException
Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.- Throws:
StripeException
-
retrieve
public static Event retrieve(java.lang.String id, RequestOptions options) throws StripeException
Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.- Throws:
StripeException
-
retrieve
public static Event retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.- Throws:
StripeException
-
retrieve
public static Event retrieve(java.lang.String id, EventRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.- Throws:
StripeException
-
getDataObjectDeserializer
public EventDataObjectDeserializer getDataObjectDeserializer()
Get deserialization helper to handle failure due to schema incompatibility. When event API version matches that of the library's pinned version, the following integration pattern is safe.Event event = getEvent(); // either from webhook or event endpoint EventDataObjectDeserializer deserializer = event.getDataObjectDeserializer(); Optional<StripeObject> stripeObject = deserializer.getObject();
You can ensure that webhook events has the same API version by creating webhook endpoint specifying api version](https://stripe.com/docs/api/webhook_endpoints/create) asStripe.API_VERSION
. For reading from old webhook endpoints or old events with potential schema incompatibility, seeEventDataObjectDeserializer.deserialize()
andEventDataObjectDeserializer.deserializeUnsafe()
.
-
getAccount
public java.lang.String getAccount()
The connected account that originated the event.
-
getApiVersion
public java.lang.String getApiVersion()
The Stripe API version used to renderdata
. Note: This property is populated only for events on or after October 31, 2014.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getData
public EventData getData()
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
event
.
-
getPendingWebhooks
public java.lang.Long getPendingWebhooks()
Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.
-
getRequest
public EventRequest getRequest()
Information on the API request that instigated the event.
-
getType
public java.lang.String getType()
Description of the event (e.g.,invoice.created
orcharge.refunded
).
-
setAccount
public void setAccount(java.lang.String account)
The connected account that originated the event.
-
setApiVersion
public void setApiVersion(java.lang.String apiVersion)
The Stripe API version used to renderdata
. Note: This property is populated only for events on or after October 31, 2014.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setData
public void setData(EventData data)
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
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
event
.
-
setPendingWebhooks
public void setPendingWebhooks(java.lang.Long pendingWebhooks)
Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.
-
setRequest
public void setRequest(EventRequest request)
Information on the API request that instigated the event.
-
setType
public void setType(java.lang.String type)
Description of the event (e.g.,invoice.created
orcharge.refunded
).
-
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
-
-