Package com.stripe.model.v2.core

Class EventNotification

java.lang.Object

com.stripe.model.v2.core.EventNotification

Direct Known Subclasses:

UnknownEventNotification, V1BillingMeterErrorReportTriggeredEventNotification, V1BillingMeterNoMeterFoundEventNotification, V2CoreEventDestinationPingEventNotification

public abstract class EventNotification
extends Object

`EventNotification` represents the common properties for json that's delivered from an Event Destination. A concrete child of `EventNotification` will be returned from `StripeClient.parseEventNotificaion()`. You will likely want to cast that object to a more specific child of `EventNotification`, like `PushedV1BillingMeterErrorReportTriggeredEvent`

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventNotification.Reason
static class	EventNotification.Request	For more details about Request, please refer to the API Reference.

Field Summary

Fields

Modifier and Type	Field	Description
protected StripeClient	client
StripeContext	context	[Optional] Authentication context needed to fetch the event or related object.
Instant	created	Time at which the object was created.
String	id	Unique identifier for the event.
Boolean	livemode	Livemode indicates if the event is from a production(true) or test(false) account.
EventNotification.Reason	reason	[Optional] Reason for the event.
String	type	The type of the event.

Constructor Summary

Constructors

Constructor	Description
EventNotification()

Method Summary

Modifier and Type	Method	Description
protected Event	fetchEvent()
protected StripeObject	fetchRelatedObject(Event.RelatedObject relatedObject)	Retrieves the object associated with the event.
static EventNotification	fromJson(String payload, StripeClient client)	Helper for constructing an Event Notification.
StripeContext	getContext()	[Optional] Authentication context needed to fetch the event or related object.
Instant	getCreated()	Time at which the object was created.
String	getId()	Unique identifier for the event.
Boolean	getLivemode()	Livemode indicates if the event is from a production(true) or test(false) account.
EventNotification.Reason	getReason()	[Optional] Reason for the event.
String	getType()	The type of the event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

@SerializedName("id")
public String id

Unique identifier for the event.

type

@SerializedName("type")
public String type

The type of the event.

created

@SerializedName("created")
public Instant created

Time at which the object was created.

livemode

@SerializedName("livemode")
public Boolean livemode

Livemode indicates if the event is from a production(true) or test(false) account.

context

@SerializedName("context")
public StripeContext context

[Optional] Authentication context needed to fetch the event or related object.

reason

@SerializedName("reason")
public EventNotification.Reason reason

[Optional] Reason for the event.

client

protected transient StripeClient client

Constructor Details

EventNotification

public EventNotification()

Method Details

fromJson

public static EventNotification fromJson(String payload,
 StripeClient client)

Helper for constructing an Event Notification. Doesn't perform signature validation, so you should use StripeClient.parseEventNotification(java.lang.String, java.lang.String, java.lang.String) instead for initial handling. This is useful in unit tests and working with EventNotifications that you've already validated the authenticity of.

fetchEvent

protected Event fetchEvent()
                    throws StripeException

Throws:

StripeException

fetchRelatedObject

protected StripeObject fetchRelatedObject(Event.RelatedObject relatedObject)
                                   throws StripeException

Retrieves the object associated with the event.

Throws:

StripeException

getId

public String getId()

Unique identifier for the event.

getType

public String getType()

The type of the event.

getCreated

public Instant getCreated()

Time at which the object was created.

getLivemode

public Boolean getLivemode()

Livemode indicates if the event is from a production(true) or test(false) account.

getContext

public StripeContext getContext()

[Optional] Authentication context needed to fetch the event or related object.

getReason

public EventNotification.Reason getReason()

[Optional] Reason for the event.