Package com.stripe.param

Class EventListParams.Builder

  • Enclosing class:
    EventListParams
    public static class EventListParams.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • build

        public EventListParams build()
        Finalize and obtain parameter instance from this builder.

      • 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.

      • putExtraParam

        public EventListParams.Builder putExtraParam​(java.lang.String key,
                                             java.lang.Object value)
        Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See EventListParams.extraParams for the field documentation.

      • putAllExtraParam

        public EventListParams.Builder putAllExtraParam​(java.util.Map<java.lang.String,​java.lang.Object> map)
        Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See EventListParams.extraParams 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.