Package com.stripe.param
Class ProductListParams.Builder
- java.lang.Object
-
- com.stripe.param.ProductListParams.Builder
-
- Enclosing class:
- ProductListParams
public static class ProductListParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProductListParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.ProductListParams.Builder
addAllId(java.util.List<java.lang.String> elements)
Add all elements to `ids` list.ProductListParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.ProductListParams.Builder
addId(java.lang.String element)
Add an element to `ids` list.ProductListParams
build()
Finalize and obtain parameter instance from this builder.ProductListParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.ProductListParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.ProductListParams.Builder
setActive(java.lang.Boolean active)
Only return products that are active or inactive (e.g., passfalse
to list all inactive products).ProductListParams.Builder
setCreated(ProductListParams.Created created)
Only return products that were created during the given date interval.ProductListParams.Builder
setCreated(java.lang.Long created)
Only return products that were created during the given date interval.ProductListParams.Builder
setEndingBefore(java.lang.String endingBefore)
A cursor for use in pagination.ProductListParams.Builder
setLimit(java.lang.Long limit)
A limit on the number of objects to be returned.ProductListParams.Builder
setShippable(java.lang.Boolean shippable)
Only return products that can be shipped (i.e., physical, not digital products).ProductListParams.Builder
setStartingAfter(java.lang.String startingAfter)
A cursor for use in pagination.ProductListParams.Builder
setType(ProductListParams.Type type)
Only return products of this type.ProductListParams.Builder
setUrl(java.lang.String url)
Only return products with the given url.
-
-
-
Method Detail
-
build
public ProductListParams build()
Finalize and obtain parameter instance from this builder.
-
setActive
public ProductListParams.Builder setActive(java.lang.Boolean active)
Only return products that are active or inactive (e.g., passfalse
to list all inactive products).
-
setCreated
public ProductListParams.Builder setCreated(ProductListParams.Created created)
Only return products that were created during the given date interval.
-
setCreated
public ProductListParams.Builder setCreated(java.lang.Long created)
Only return products that were created during the given date interval.
-
setEndingBefore
public ProductListParams.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 withobj_bar
, your subsequent call can includeending_before=obj_bar
in order to fetch the previous page of the list.
-
addExpand
public ProductListParams.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. SeeProductListParams.expand
for the field documentation.
-
addAllExpand
public ProductListParams.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. SeeProductListParams.expand
for the field documentation.
-
putExtraParam
public ProductListParams.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. SeeProductListParams.extraParams
for the field documentation.
-
putAllExtraParam
public ProductListParams.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. SeeProductListParams.extraParams
for the field documentation.
-
addId
public ProductListParams.Builder addId(java.lang.String element)
Add an element to `ids` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeProductListParams.ids
for the field documentation.
-
addAllId
public ProductListParams.Builder addAllId(java.util.List<java.lang.String> elements)
Add all elements to `ids` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeProductListParams.ids
for the field documentation.
-
setLimit
public ProductListParams.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.
-
setShippable
public ProductListParams.Builder setShippable(java.lang.Boolean shippable)
Only return products that can be shipped (i.e., physical, not digital products).
-
setStartingAfter
public ProductListParams.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 withobj_foo
, your subsequent call can includestarting_after=obj_foo
in order to fetch the next page of the list.
-
setType
public ProductListParams.Builder setType(ProductListParams.Type type)
Only return products of this type.
-
setUrl
public ProductListParams.Builder setUrl(java.lang.String url)
Only return products with the given url.
-
-