com.stripe.param

Class EventListParams.Builder

java.lang.Object

com.stripe.param.EventListParams.Builder

Enclosing class:

EventListParams

public static class EventListParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EventListParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
EventListParams.Builder	addAllType(java.util.List<java.lang.String> elements) Add all elements to `types` list.
EventListParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
EventListParams.Builder	addType(java.lang.String element) Add an element to `types` list.
EventListParams	build() Finalize and obtain parameter instance from this builder.
EventListParams.Builder	setCreated(EventListParams.Created created)
EventListParams.Builder	setCreated(java.lang.Long created)
EventListParams.Builder	setDeliverySuccess(java.lang.Boolean deliverySuccess) Filter events by whether all webhooks were successfully delivered.
EventListParams.Builder	setEndingBefore(java.lang.String endingBefore) A cursor for use in pagination.
EventListParams.Builder	setLimit(java.lang.Long limit) A limit on the number of objects to be returned.
EventListParams.Builder	setStartingAfter(java.lang.String startingAfter) A cursor for use in pagination.
EventListParams.Builder	setType(java.lang.String type) A string containing a specific event name, or group of events using * as a wildcard.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public EventListParams build()

Finalize and obtain parameter instance from this builder.

setCreated

public EventListParams.Builder setCreated(EventListParams.Created created)

setCreated

public EventListParams.Builder setCreated(java.lang.Long created)

setDeliverySuccess

public EventListParams.Builder setDeliverySuccess(java.lang.Boolean deliverySuccess)

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.

setEndingBefore

public EventListParams.Builder setEndingBefore(java.lang.String endingBefore)

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.

addExpand

public EventListParams.Builder addExpand(java.lang.String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See EventListParams.expand for the field documentation.

addAllExpand

public EventListParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See EventListParams.expand for the field documentation.

setLimit

public EventListParams.Builder setLimit(java.lang.Long limit)

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

setStartingAfter

public EventListParams.Builder setStartingAfter(java.lang.String startingAfter)

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.

setType

public EventListParams.Builder setType(java.lang.String type)

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.

addType

public EventListParams.Builder addType(java.lang.String element)

Add an element to `types` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See EventListParams.types for the field documentation.

addAllType

public EventListParams.Builder addAllType(java.util.List<java.lang.String> elements)

Add all elements to `types` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See EventListParams.types for the field documentation.