ProductUpdateParams.Builder (stripe-java 9.7.0 API)

java.lang.Object
- com.stripe.param.ProductUpdateParams.Builder

Enclosing class:: ProductUpdateParams

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

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProductUpdateParams.Builder`	`addAllDeactivateOn(java.util.List<java.lang.String> elements)` Add all elements to `deactivateOn` list.
`ProductUpdateParams.Builder`	`addAllExpand(java.util.List<java.lang.String> elements)` Add all elements to `expand` list.
`ProductUpdateParams.Builder`	`addDeactivateOn(java.lang.String element)` Add an element to `deactivateOn` list.
`ProductUpdateParams.Builder`	`addExpand(java.lang.String element)` Add an element to `expand` list.
`ProductUpdateParams`	`build()` Finalize and obtain parameter instance from this builder.
`ProductUpdateParams.Builder`	`putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)` Add all map key/value pairs to `metadata` map.
`ProductUpdateParams.Builder`	`putMetadata(java.lang.String key, java.lang.String value)` Add a key/value pair to `metadata` map.
`ProductUpdateParams.Builder`	`setActive(java.lang.Boolean active)` Whether the product is available for purchase.
`ProductUpdateParams.Builder`	`setAttributes(EmptyParam attributes)` A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`).
`ProductUpdateParams.Builder`	`setAttributes(java.util.List<java.lang.String> attributes)` A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`).
`ProductUpdateParams.Builder`	`setCaption(java.lang.String caption)` A short one-line description of the product, meant to be displayable to the customer.
`ProductUpdateParams.Builder`	`setDescription(java.lang.String description)` The product's description, meant to be displayable to the customer.
`ProductUpdateParams.Builder`	`setImages(EmptyParam images)` A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
`ProductUpdateParams.Builder`	`setImages(java.util.List<java.lang.String> images)` A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
`ProductUpdateParams.Builder`	`setName(java.lang.String name)` The product's name, meant to be displayable to the customer.
`ProductUpdateParams.Builder`	`setPackageDimensions(EmptyParam packageDimensions)` The dimensions of this product for shipping purposes.
`ProductUpdateParams.Builder`	`setPackageDimensions(ProductUpdateParams.PackageDimensions packageDimensions)` The dimensions of this product for shipping purposes.
`ProductUpdateParams.Builder`	`setShippable(java.lang.Boolean shippable)` Whether this product is shipped (i.e., physical goods).
`ProductUpdateParams.Builder`	`setStatementDescriptor(java.lang.String statementDescriptor)` An arbitrary string to be displayed on your customer's credit card statement.
`ProductUpdateParams.Builder`	`setUnitLabel(java.lang.String unitLabel)` A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices.
`ProductUpdateParams.Builder`	`setUrl(java.lang.String url)` A URL of a publicly-accessible webpage for this product.

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 ProductUpdateParams build()
```
    Finalize and obtain parameter instance from this builder.
  - setActive
```
public ProductUpdateParams.Builder setActive(java.lang.Boolean active)
```
    Whether the product is available for purchase.
  - setAttributes
```
public ProductUpdateParams.Builder setAttributes(EmptyParam attributes)
```
    A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product.
  - setAttributes
```
public ProductUpdateParams.Builder setAttributes(java.util.List<java.lang.String> attributes)
```
    A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product.
  - setCaption
```
public ProductUpdateParams.Builder setCaption(java.lang.String caption)
```
    A short one-line description of the product, meant to be displayable to the customer.
  - addDeactivateOn
```
public ProductUpdateParams.Builder addDeactivateOn(java.lang.String element)
```
    Add an element to `deactivateOn` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.deactivateOn for the field documentation.
  - addAllDeactivateOn
```
public ProductUpdateParams.Builder addAllDeactivateOn(java.util.List<java.lang.String> elements)
```
    Add all elements to `deactivateOn` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.deactivateOn for the field documentation.
  - setDescription
```
public ProductUpdateParams.Builder setDescription(java.lang.String description)
```
    The product's description, meant to be displayable to the customer.
  - addExpand
```
public ProductUpdateParams.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 ProductUpdateParams.expand for the field documentation.
  - addAllExpand
```
public ProductUpdateParams.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 ProductUpdateParams.expand for the field documentation.
  - setImages
```
public ProductUpdateParams.Builder setImages(EmptyParam images)
```
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
  - setImages
```
public ProductUpdateParams.Builder setImages(java.util.List<java.lang.String> images)
```
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
  - putMetadata
```
public ProductUpdateParams.Builder putMetadata(java.lang.String key,
                                               java.lang.String value)
```
    Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ProductUpdateParams.metadata for the field documentation.
  - putAllMetadata
```
public ProductUpdateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
```
    Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ProductUpdateParams.metadata for the field documentation.
  - setName
```
public ProductUpdateParams.Builder setName(java.lang.String name)
```
    The product's name, meant to be displayable to the customer. Applicable to both `service` and `good` types.
  - setPackageDimensions
```
public ProductUpdateParams.Builder setPackageDimensions(ProductUpdateParams.PackageDimensions packageDimensions)
```
    The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`.
  - setPackageDimensions
```
public ProductUpdateParams.Builder setPackageDimensions(EmptyParam packageDimensions)
```
    The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`.
  - setShippable
```
public ProductUpdateParams.Builder setShippable(java.lang.Boolean shippable)
```
    Whether this product is shipped (i.e., physical goods). Defaults to `true`.
  - setStatementDescriptor
```
public ProductUpdateParams.Builder setStatementDescriptor(java.lang.String statementDescriptor)
```
    An arbitrary string to be displayed on your customer's credit card statement. This may be up to 22 characters. The statement description may not include "' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all. It must contain at least one letter. May only be set if type=`service`.
  - setUnitLabel
```
public ProductUpdateParams.Builder setUnitLabel(java.lang.String unitLabel)
```
    A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices. Only available on products of type=`service`.
  - setUrl
```
public ProductUpdateParams.Builder setUrl(java.lang.String url)
```
    A URL of a publicly-accessible webpage for this product.

Class ProductUpdateParams.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setActive

setAttributes

setAttributes

setCaption

addDeactivateOn

addAllDeactivateOn

setDescription

addExpand

addAllExpand

setImages

setImages

putMetadata

putAllMetadata

setName

setPackageDimensions

setPackageDimensions

setShippable

setStatementDescriptor

setUnitLabel

setUrl