Package com.stripe.param
Class EventListParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.EventListParams
-
public class EventListParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEventListParams.Builderstatic classEventListParams.Created-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EventListParams.Builderbuilder()java.lang.ObjectgetCreated()java.lang.BooleangetDeliverySuccess()Filter events by whether all webhooks were successfully delivered.java.lang.StringgetEndingBefore()A cursor for use in pagination.java.util.List<java.lang.String>getExpand()Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>getExtraParams()Map of extra parameters for custom features not available in this client library.java.lang.LonggetLimit()A limit on the number of objects to be returned.java.lang.StringgetStartingAfter()A cursor for use in pagination.java.lang.StringgetType()A string containing a specific event name, or group of events using * as a wildcard.java.util.List<java.lang.String>getTypes()An array of up to 20 strings containing specific event names.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static EventListParams.Builder builder()
-
getCreated
public java.lang.Object getCreated()
-
getDeliverySuccess
public java.lang.Boolean getDeliverySuccess()
Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
-
getEndingBefore
public java.lang.String getEndingBefore()
A cursor for use in pagination.ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedNamevalue. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
-
getLimit
public java.lang.Long getLimit()
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-
getStartingAfter
public java.lang.String getStartingAfter()
A cursor for use in pagination.starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
-
getType
public java.lang.String getType()
A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
-
getTypes
public java.util.List<java.lang.String> getTypes()
An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass eithertypeortypes, but not both.
-
-