com.stripe.param

Class CustomerListParams.Builder

java.lang.Object

com.stripe.param.CustomerListParams.Builder

Enclosing class:

CustomerListParams

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CustomerListParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
CustomerListParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
CustomerListParams	build() Finalize and obtain parameter instance from this builder.
CustomerListParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
CustomerListParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
CustomerListParams.Builder	setCreated(CustomerListParams.Created created)
CustomerListParams.Builder	setCreated(java.lang.Long created)
CustomerListParams.Builder	setEmail(java.lang.String email) A filter on the list based on the customer's `email` field.
CustomerListParams.Builder	setEndingBefore(java.lang.String endingBefore) A cursor for use in pagination.
CustomerListParams.Builder	setLimit(java.lang.Long limit) A limit on the number of objects to be returned.
CustomerListParams.Builder	setStartingAfter(java.lang.String startingAfter) A cursor for use in pagination.

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 CustomerListParams build()

Finalize and obtain parameter instance from this builder.

setCreated

public CustomerListParams.Builder setCreated(CustomerListParams.Created created)

setCreated

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

setEmail

public CustomerListParams.Builder setEmail(java.lang.String email)

A filter on the list based on the customer's `email` field. The value must be a string.

setEndingBefore

public CustomerListParams.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 CustomerListParams.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 CustomerListParams.expand for the field documentation.

addAllExpand

public CustomerListParams.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 CustomerListParams.expand for the field documentation.

putExtraParam

public CustomerListParams.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 CustomerListParams.extraParams for the field documentation.

putAllExtraParam

public CustomerListParams.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 CustomerListParams.extraParams for the field documentation.

setLimit

public CustomerListParams.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 CustomerListParams.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.