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 and Description
static class	EventListParams.Builder
static class	EventListParams.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

Modifier and Type	Method and Description
static EventListParams.Builder	builder()
java.lang.Object	getCreated()
java.lang.Boolean	getDeliverySuccess() Filter events by whether all webhooks were successfully delivered.
java.lang.String	getEndingBefore() 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.Long	getLimit() A limit on the number of objects to be returned.
java.lang.String	getStartingAfter() A cursor for use in pagination.
java.lang.String	getType() 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

Methods inherited from class java.lang.Object

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

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_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in 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 @SerializedName value. 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_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in 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 either type or types, but not both.