com.stripe.param

Class PromotionCodeListParams.Builder

java.lang.Object

com.stripe.param.PromotionCodeListParams.Builder

Enclosing class:

PromotionCodeListParams

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PromotionCodeListParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
PromotionCodeListParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
PromotionCodeListParams	build() Finalize and obtain parameter instance from this builder.
PromotionCodeListParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
PromotionCodeListParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
PromotionCodeListParams.Builder	setActive(java.lang.Boolean active) Filter promotion codes by whether they are active.
PromotionCodeListParams.Builder	setCode(java.lang.String code) Only return promotion codes that have this case-insensitive code.
PromotionCodeListParams.Builder	setCoupon(java.lang.String coupon) Only return promotion codes for this coupon.
PromotionCodeListParams.Builder	setCreated(java.lang.Long created) A filter on the list, based on the object created field.
PromotionCodeListParams.Builder	setCreated(PromotionCodeListParams.Created created) A filter on the list, based on the object created field.
PromotionCodeListParams.Builder	setCustomer(java.lang.String customer) Only return promotion codes that are restricted to this customer.
PromotionCodeListParams.Builder	setEndingBefore(java.lang.String endingBefore) A cursor for use in pagination.
PromotionCodeListParams.Builder	setLimit(java.lang.Long limit) A limit on the number of objects to be returned.
PromotionCodeListParams.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 PromotionCodeListParams build()

Finalize and obtain parameter instance from this builder.

setActive

public PromotionCodeListParams.Builder setActive(java.lang.Boolean active)

Filter promotion codes by whether they are active.

setCode

public PromotionCodeListParams.Builder setCode(java.lang.String code)

Only return promotion codes that have this case-insensitive code.

setCoupon

public PromotionCodeListParams.Builder setCoupon(java.lang.String coupon)

Only return promotion codes for this coupon.

setCreated

public PromotionCodeListParams.Builder setCreated(PromotionCodeListParams.Created created)

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

setCreated

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

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

setCustomer

public PromotionCodeListParams.Builder setCustomer(java.lang.String customer)

Only return promotion codes that are restricted to this customer.

setEndingBefore

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

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

setLimit

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