Package com.stripe.model.billing

Class Alert

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.billing.Alert

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class Alert
extends ApiResource
implements HasId

A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Alert.Filter
static class	Alert.UsageThresholdConfig	The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Alert()

Method Summary

Modifier and Type	Method	Description
Alert	activate()	Reactivates this alert, allowing it to trigger again.
Alert	activate(RequestOptions options)	Reactivates this alert, allowing it to trigger again.
Alert	activate(AlertActivateParams params)	Reactivates this alert, allowing it to trigger again.
Alert	activate(AlertActivateParams params, RequestOptions options)	Reactivates this alert, allowing it to trigger again.
Alert	activate(Map<String,Object> params)	Reactivates this alert, allowing it to trigger again.
Alert	activate(Map<String,Object> params, RequestOptions options)	Reactivates this alert, allowing it to trigger again.
Alert	archive()	Archives this alert, removing it from the list view and APIs.
Alert	archive(RequestOptions options)	Archives this alert, removing it from the list view and APIs.
Alert	archive(AlertArchiveParams params)	Archives this alert, removing it from the list view and APIs.
Alert	archive(AlertArchiveParams params, RequestOptions options)	Archives this alert, removing it from the list view and APIs.
Alert	archive(Map<String,Object> params)	Archives this alert, removing it from the list view and APIs.
Alert	archive(Map<String,Object> params, RequestOptions options)	Archives this alert, removing it from the list view and APIs.
protected boolean	canEqual(Object other)
static Alert	create(AlertCreateParams params)	Creates a billing alert.
static Alert	create(AlertCreateParams params, RequestOptions options)	Creates a billing alert.
static Alert	create(Map<String,Object> params)	Creates a billing alert.
static Alert	create(Map<String,Object> params, RequestOptions options)	Creates a billing alert.
Alert	deactivate()	Deactivates this alert, preventing it from triggering.
Alert	deactivate(RequestOptions options)	Deactivates this alert, preventing it from triggering.
Alert	deactivate(AlertDeactivateParams params)	Deactivates this alert, preventing it from triggering.
Alert	deactivate(AlertDeactivateParams params, RequestOptions options)	Deactivates this alert, preventing it from triggering.
Alert	deactivate(Map<String,Object> params)	Deactivates this alert, preventing it from triggering.
Alert	deactivate(Map<String,Object> params, RequestOptions options)	Deactivates this alert, preventing it from triggering.
boolean	equals(Object o)
String	getAlertType()	Defines the type of the alert.
Alert.Filter	getFilter()	Limits the scope of the alert to a specific customer.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
String	getStatus()	Status of the alert.
String	getTitle()	Title of the alert.
Alert.UsageThresholdConfig	getUsageThresholdConfig()	Encapsulates configuration of the alert to monitor usage on a specific Billing Meter.
int	hashCode()
static AlertCollection	list(AlertListParams params)	Lists billing active and inactive alerts.
static AlertCollection	list(AlertListParams params, RequestOptions options)	Lists billing active and inactive alerts.
static AlertCollection	list(Map<String,Object> params)	Lists billing active and inactive alerts.
static AlertCollection	list(Map<String,Object> params, RequestOptions options)	Lists billing active and inactive alerts.
static Alert	retrieve(String id)	Retrieves a billing alert given an ID.
static Alert	retrieve(String id, RequestOptions options)	Retrieves a billing alert given an ID.
static Alert	retrieve(String id, AlertRetrieveParams params, RequestOptions options)	Retrieves a billing alert given an ID.
static Alert	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a billing alert given an ID.
void	setAlertType(String alertType)	Defines the type of the alert.
void	setFilter(Alert.Filter filter)	Limits the scope of the alert to a specific customer.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(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	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setStatus(String status)	Status of the alert.
void	setTitle(String title)	Title of the alert.
void	setUsageThresholdConfig(Alert.UsageThresholdConfig usageThresholdConfig)	Encapsulates configuration of the alert to monitor usage on a specific Billing Meter.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Alert

public Alert()

Method Details

activate

public Alert activate()
               throws StripeException

Reactivates this alert, allowing it to trigger again.

Throws:

StripeException

activate

public Alert activate(RequestOptions options)
               throws StripeException

Reactivates this alert, allowing it to trigger again.

Throws:

StripeException

activate

public Alert activate(Map<String,Object> params)
               throws StripeException

Reactivates this alert, allowing it to trigger again.

Throws:

StripeException

activate

public Alert activate(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

Reactivates this alert, allowing it to trigger again.

Throws:

StripeException

activate

public Alert activate(AlertActivateParams params)
               throws StripeException

Reactivates this alert, allowing it to trigger again.

Throws:

StripeException

activate

public Alert activate(AlertActivateParams params,
 RequestOptions options)
               throws StripeException

Reactivates this alert, allowing it to trigger again.

Throws:

StripeException

archive

public Alert archive()
              throws StripeException

Archives this alert, removing it from the list view and APIs. This is non-reversible.

Throws:

StripeException

archive

public Alert archive(RequestOptions options)
              throws StripeException

Archives this alert, removing it from the list view and APIs. This is non-reversible.

Throws:

StripeException

archive

public Alert archive(Map<String,Object> params)
              throws StripeException

Archives this alert, removing it from the list view and APIs. This is non-reversible.

Throws:

StripeException

archive

public Alert archive(Map<String,Object> params,
 RequestOptions options)
              throws StripeException

Archives this alert, removing it from the list view and APIs. This is non-reversible.

Throws:

StripeException

archive

public Alert archive(AlertArchiveParams params)
              throws StripeException

Archives this alert, removing it from the list view and APIs. This is non-reversible.

Throws:

StripeException

archive

public Alert archive(AlertArchiveParams params,
 RequestOptions options)
              throws StripeException

Archives this alert, removing it from the list view and APIs. This is non-reversible.

Throws:

StripeException

create

public static Alert create(Map<String,Object> params)
                    throws StripeException

Creates a billing alert.

Throws:

StripeException

create

public static Alert create(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

Creates a billing alert.

Throws:

StripeException

create

public static Alert create(AlertCreateParams params)
                    throws StripeException

Creates a billing alert.

Throws:

StripeException

create

public static Alert create(AlertCreateParams params,
 RequestOptions options)
                    throws StripeException

Creates a billing alert.

Throws:

StripeException

deactivate

public Alert deactivate()
                 throws StripeException

Deactivates this alert, preventing it from triggering.

Throws:

StripeException

deactivate

public Alert deactivate(RequestOptions options)
                 throws StripeException

Deactivates this alert, preventing it from triggering.

Throws:

StripeException

deactivate

public Alert deactivate(Map<String,Object> params)
                 throws StripeException

Deactivates this alert, preventing it from triggering.

Throws:

StripeException

deactivate

public Alert deactivate(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

Deactivates this alert, preventing it from triggering.

Throws:

StripeException

deactivate

public Alert deactivate(AlertDeactivateParams params)
                 throws StripeException

Deactivates this alert, preventing it from triggering.

Throws:

StripeException

deactivate

public Alert deactivate(AlertDeactivateParams params,
 RequestOptions options)
                 throws StripeException

Deactivates this alert, preventing it from triggering.

Throws:

StripeException

list

public static AlertCollection list(Map<String,Object> params)
                            throws StripeException

Lists billing active and inactive alerts.

Throws:

StripeException

list

public static AlertCollection list(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Lists billing active and inactive alerts.

Throws:

StripeException

list

public static AlertCollection list(AlertListParams params)
                            throws StripeException

Lists billing active and inactive alerts.

Throws:

StripeException

list

public static AlertCollection list(AlertListParams params,
 RequestOptions options)
                            throws StripeException

Lists billing active and inactive alerts.

Throws:

StripeException

retrieve

public static Alert retrieve(String id)
                      throws StripeException

Retrieves a billing alert given an ID.

Throws:

StripeException

retrieve

public static Alert retrieve(String id,
 RequestOptions options)
                      throws StripeException

Retrieves a billing alert given an ID.

Throws:

StripeException

retrieve

public static Alert retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

Retrieves a billing alert given an ID.

Throws:

StripeException

retrieve

public static Alert retrieve(String id,
 AlertRetrieveParams params,
 RequestOptions options)
                      throws StripeException

Retrieves a billing alert given an ID.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAlertType

public String getAlertType()

Defines the type of the alert.

Equal to usage_threshold.

getFilter

public Alert.Filter getFilter()

Limits the scope of the alert to a specific customer.

getLivemode

public Boolean getLivemode()

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

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to billing.alert.

getStatus

public String getStatus()

Status of the alert. This can be active, inactive or archived.

One of active, archived, or inactive.

getTitle

public String getTitle()

Title of the alert.

getUsageThresholdConfig

public Alert.UsageThresholdConfig getUsageThresholdConfig()

Encapsulates configuration of the alert to monitor usage on a specific Billing Meter.

setAlertType

public void setAlertType(String alertType)

Defines the type of the alert.

Equal to usage_threshold.

setFilter

public void setFilter(Alert.Filter filter)

Limits the scope of the alert to a specific customer.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

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

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to billing.alert.

setStatus

public void setStatus(String status)

Status of the alert. This can be active, inactive or archived.

One of active, archived, or inactive.

setTitle

public void setTitle(String title)

Title of the alert.

setUsageThresholdConfig

public void setUsageThresholdConfig(Alert.UsageThresholdConfig usageThresholdConfig)

Encapsulates configuration of the alert to monitor usage on a specific Billing Meter.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId