com.stripe.param

Class SkuListParams.Builder

java.lang.Object

com.stripe.param.SkuListParams.Builder

Enclosing class:

SkuListParams

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SkuListParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
SkuListParams.Builder	addAllId(java.util.List<java.lang.String> elements) Add all elements to `ids` list.
SkuListParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
SkuListParams.Builder	addId(java.lang.String element) Add an element to `ids` list.
SkuListParams	build() Finalize and obtain parameter instance from this builder.
SkuListParams.Builder	putAllAttribute(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `attributes` map.
SkuListParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
SkuListParams.Builder	putAttribute(java.lang.String key, java.lang.String value) Add a key/value pair to `attributes` map.
SkuListParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
SkuListParams.Builder	setActive(java.lang.Boolean active) Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products).
SkuListParams.Builder	setEndingBefore(java.lang.String endingBefore) A cursor for use in pagination.
SkuListParams.Builder	setInStock(java.lang.Boolean inStock) Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock).
SkuListParams.Builder	setLimit(java.lang.Long limit) A limit on the number of objects to be returned.
SkuListParams.Builder	setProduct(java.lang.String product) The ID of the product whose SKUs will be retrieved.
SkuListParams.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 SkuListParams build()

Finalize and obtain parameter instance from this builder.

setActive

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

Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products).

putAttribute

public SkuListParams.Builder putAttribute(java.lang.String key,
                                          java.lang.String value)

Add a key/value pair to `attributes` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SkuListParams.attributes for the field documentation.

putAllAttribute

public SkuListParams.Builder putAllAttribute(java.util.Map<java.lang.String,java.lang.String> map)

Add all map key/value pairs to `attributes` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SkuListParams.attributes for the field documentation.

setEndingBefore

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

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

addId

public SkuListParams.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. See SkuListParams.ids for the field documentation.

addAllId

public SkuListParams.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. See SkuListParams.ids for the field documentation.

setInStock

public SkuListParams.Builder setInStock(java.lang.Boolean inStock)

Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.

setLimit

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

setProduct

public SkuListParams.Builder setProduct(java.lang.String product)

The ID of the product whose SKUs will be retrieved. Must be a product with type `good`.

setStartingAfter

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