CatalogItem.Builder (Square 37.0.0.20240118 API)

java.lang.Object
- com.squareup.square.models.CatalogItem.Builder

Enclosing class:

CatalogItem
```
public static class CatalogItem.Builder
extends Object
```
Class to build instances of CatalogItem.

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
`CatalogItem.Builder`	`abbreviation(String abbreviation)` Setter for abbreviation.
`CatalogItem.Builder`	`availableElectronically(Boolean availableElectronically)` Setter for availableElectronically.
`CatalogItem.Builder`	`availableForPickup(Boolean availableForPickup)` Setter for availableForPickup.
`CatalogItem.Builder`	`availableOnline(Boolean availableOnline)` Setter for availableOnline.
`CatalogItem`	`build()` Builds a new `CatalogItem` object using the set fields.
`CatalogItem.Builder`	`categories(List<CatalogObjectCategory> categories)` Setter for categories.
`CatalogItem.Builder`	`categoryId(String categoryId)` Setter for categoryId.
`CatalogItem.Builder`	`channels(List<String> channels)` Setter for channels.
`CatalogItem.Builder`	`description(String description)` Setter for description.
`CatalogItem.Builder`	`descriptionHtml(String descriptionHtml)` Setter for descriptionHtml.
`CatalogItem.Builder`	`descriptionPlaintext(String descriptionPlaintext)` Setter for descriptionPlaintext.
`CatalogItem.Builder`	`ecomSeoData(CatalogEcomSeoData ecomSeoData)` Setter for ecomSeoData.
`CatalogItem.Builder`	`foodAndBeverageDetails(CatalogItemFoodAndBeverageDetails foodAndBeverageDetails)` Setter for foodAndBeverageDetails.
`CatalogItem.Builder`	`imageIds(List<String> imageIds)` Setter for imageIds.
`CatalogItem.Builder`	`isArchived(Boolean isArchived)` Setter for isArchived.
`CatalogItem.Builder`	`itemOptions(List<CatalogItemOptionForItem> itemOptions)` Setter for itemOptions.
`CatalogItem.Builder`	`labelColor(String labelColor)` Setter for labelColor.
`CatalogItem.Builder`	`modifierListInfo(List<CatalogItemModifierListInfo> modifierListInfo)` Setter for modifierListInfo.
`CatalogItem.Builder`	`name(String name)` Setter for name.
`CatalogItem.Builder`	`productType(String productType)` Setter for productType.
`CatalogItem.Builder`	`reportingCategory(CatalogObjectCategory reportingCategory)` Setter for reportingCategory.
`CatalogItem.Builder`	`skipModifierScreen(Boolean skipModifierScreen)` Setter for skipModifierScreen.
`CatalogItem.Builder`	`sortName(String sortName)` Setter for sortName.
`CatalogItem.Builder`	`taxIds(List<String> taxIds)` Setter for taxIds.
`CatalogItem.Builder`	`unsetAbbreviation()` UnSetter for abbreviation.
`CatalogItem.Builder`	`unsetAvailableElectronically()` UnSetter for availableElectronically.
`CatalogItem.Builder`	`unsetAvailableForPickup()` UnSetter for availableForPickup.
`CatalogItem.Builder`	`unsetAvailableOnline()` UnSetter for availableOnline.
`CatalogItem.Builder`	`unsetCategories()` UnSetter for categories.
`CatalogItem.Builder`	`unsetCategoryId()` UnSetter for categoryId.
`CatalogItem.Builder`	`unsetChannels()` UnSetter for channels.
`CatalogItem.Builder`	`unsetDescription()` UnSetter for description.
`CatalogItem.Builder`	`unsetDescriptionHtml()` UnSetter for descriptionHtml.
`CatalogItem.Builder`	`unsetImageIds()` UnSetter for imageIds.
`CatalogItem.Builder`	`unsetIsArchived()` UnSetter for isArchived.
`CatalogItem.Builder`	`unsetItemOptions()` UnSetter for itemOptions.
`CatalogItem.Builder`	`unsetLabelColor()` UnSetter for labelColor.
`CatalogItem.Builder`	`unsetModifierListInfo()` UnSetter for modifierListInfo.
`CatalogItem.Builder`	`unsetName()` UnSetter for name.
`CatalogItem.Builder`	`unsetSkipModifierScreen()` UnSetter for skipModifierScreen.
`CatalogItem.Builder`	`unsetSortName()` UnSetter for sortName.
`CatalogItem.Builder`	`unsetTaxIds()` UnSetter for taxIds.
`CatalogItem.Builder`	`unsetVariations()` UnSetter for variations.
`CatalogItem.Builder`	`variations(List<CatalogObject> variations)` Setter for variations.

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
  - name
```
public CatalogItem.Builder name(String name)
```
    Setter for name.
    
    Parameters:
    
    name - String value for name.
    
    Returns:
    
    Builder
  - unsetName
```
public CatalogItem.Builder unsetName()
```
    UnSetter for name.
    
    Returns:
    
    Builder
  - description
```
public CatalogItem.Builder description(String description)
```
    Setter for description.
    
    Parameters:
    
    description - String value for description.
    
    Returns:
    
    Builder
  - unsetDescription
```
public CatalogItem.Builder unsetDescription()
```
    UnSetter for description.
    
    Returns:
    
    Builder
  - abbreviation
```
public CatalogItem.Builder abbreviation(String abbreviation)
```
    Setter for abbreviation.
    
    Parameters:
    
    abbreviation - String value for abbreviation.
    
    Returns:
    
    Builder
  - unsetAbbreviation
```
public CatalogItem.Builder unsetAbbreviation()
```
    UnSetter for abbreviation.
    
    Returns:
    
    Builder
  - labelColor
```
public CatalogItem.Builder labelColor(String labelColor)
```
    Setter for labelColor.
    
    Parameters:
    
    labelColor - String value for labelColor.
    
    Returns:
    
    Builder
  - unsetLabelColor
```
public CatalogItem.Builder unsetLabelColor()
```
    UnSetter for labelColor.
    
    Returns:
    
    Builder
  - availableOnline
```
public CatalogItem.Builder availableOnline(Boolean availableOnline)
```
    Setter for availableOnline.
    
    Parameters:
    
    availableOnline - Boolean value for availableOnline.
    
    Returns:
    
    Builder
  - unsetAvailableOnline
```
public CatalogItem.Builder unsetAvailableOnline()
```
    UnSetter for availableOnline.
    
    Returns:
    
    Builder
  - availableForPickup
```
public CatalogItem.Builder availableForPickup(Boolean availableForPickup)
```
    Setter for availableForPickup.
    
    Parameters:
    
    availableForPickup - Boolean value for availableForPickup.
    
    Returns:
    
    Builder
  - unsetAvailableForPickup
```
public CatalogItem.Builder unsetAvailableForPickup()
```
    UnSetter for availableForPickup.
    
    Returns:
    
    Builder
  - availableElectronically
```
public CatalogItem.Builder availableElectronically(Boolean availableElectronically)
```
    Setter for availableElectronically.
    
    Parameters:
    
    availableElectronically - Boolean value for availableElectronically.
    
    Returns:
    
    Builder
  - unsetAvailableElectronically
```
public CatalogItem.Builder unsetAvailableElectronically()
```
    UnSetter for availableElectronically.
    
    Returns:
    
    Builder
  - categoryId
```
public CatalogItem.Builder categoryId(String categoryId)
```
    Setter for categoryId.
    
    Parameters:
    
    categoryId - String value for categoryId.
    
    Returns:
    
    Builder
  - unsetCategoryId
```
public CatalogItem.Builder unsetCategoryId()
```
    UnSetter for categoryId.
    
    Returns:
    
    Builder
  - taxIds
```
public CatalogItem.Builder taxIds(List<String> taxIds)
```
    Setter for taxIds.
    
    Parameters:
    
    taxIds - List of String value for taxIds.
    
    Returns:
    
    Builder
  - unsetTaxIds
```
public CatalogItem.Builder unsetTaxIds()
```
    UnSetter for taxIds.
    
    Returns:
    
    Builder
  - modifierListInfo
```
public CatalogItem.Builder modifierListInfo(List<CatalogItemModifierListInfo> modifierListInfo)
```
    Setter for modifierListInfo.
    
    Parameters:
    
    modifierListInfo - List of CatalogItemModifierListInfo value for modifierListInfo.
    
    Returns:
    
    Builder
  - unsetModifierListInfo
```
public CatalogItem.Builder unsetModifierListInfo()
```
    UnSetter for modifierListInfo.
    
    Returns:
    
    Builder
  - variations
```
public CatalogItem.Builder variations(List<CatalogObject> variations)
```
    Setter for variations.
    
    Parameters:
    
    variations - List of CatalogObject value for variations.
    
    Returns:
    
    Builder
  - unsetVariations
```
public CatalogItem.Builder unsetVariations()
```
    UnSetter for variations.
    
    Returns:
    
    Builder
  - productType
```
public CatalogItem.Builder productType(String productType)
```
    Setter for productType.
    
    Parameters:
    
    productType - String value for productType.
    
    Returns:
    
    Builder
  - skipModifierScreen
```
public CatalogItem.Builder skipModifierScreen(Boolean skipModifierScreen)
```
    Setter for skipModifierScreen.
    
    Parameters:
    
    skipModifierScreen - Boolean value for skipModifierScreen.
    
    Returns:
    
    Builder
  - unsetSkipModifierScreen
```
public CatalogItem.Builder unsetSkipModifierScreen()
```
    UnSetter for skipModifierScreen.
    
    Returns:
    
    Builder
  - itemOptions
```
public CatalogItem.Builder itemOptions(List<CatalogItemOptionForItem> itemOptions)
```
    Setter for itemOptions.
    
    Parameters:
    
    itemOptions - List of CatalogItemOptionForItem value for itemOptions.
    
    Returns:
    
    Builder
  - unsetItemOptions
```
public CatalogItem.Builder unsetItemOptions()
```
    UnSetter for itemOptions.
    
    Returns:
    
    Builder
  - imageIds
```
public CatalogItem.Builder imageIds(List<String> imageIds)
```
    Setter for imageIds.
    
    Parameters:
    
    imageIds - List of String value for imageIds.
    
    Returns:
    
    Builder
  - unsetImageIds
```
public CatalogItem.Builder unsetImageIds()
```
    UnSetter for imageIds.
    
    Returns:
    
    Builder
  - sortName
```
public CatalogItem.Builder sortName(String sortName)
```
    Setter for sortName.
    
    Parameters:
    
    sortName - String value for sortName.
    
    Returns:
    
    Builder
  - unsetSortName
```
public CatalogItem.Builder unsetSortName()
```
    UnSetter for sortName.
    
    Returns:
    
    Builder
  - categories
```
public CatalogItem.Builder categories(List<CatalogObjectCategory> categories)
```
    Setter for categories.
    
    Parameters:
    
    categories - List of CatalogObjectCategory value for categories.
    
    Returns:
    
    Builder
  - unsetCategories
```
public CatalogItem.Builder unsetCategories()
```
    UnSetter for categories.
    
    Returns:
    
    Builder
  - descriptionHtml
```
public CatalogItem.Builder descriptionHtml(String descriptionHtml)
```
    Setter for descriptionHtml.
    
    Parameters:
    
    descriptionHtml - String value for descriptionHtml.
    
    Returns:
    
    Builder
  - unsetDescriptionHtml
```
public CatalogItem.Builder unsetDescriptionHtml()
```
    UnSetter for descriptionHtml.
    
    Returns:
    
    Builder
  - descriptionPlaintext
```
public CatalogItem.Builder descriptionPlaintext(String descriptionPlaintext)
```
    Setter for descriptionPlaintext.
    
    Parameters:
    
    descriptionPlaintext - String value for descriptionPlaintext.
    
    Returns:
    
    Builder
  - channels
```
public CatalogItem.Builder channels(List<String> channels)
```
    Setter for channels.
    
    Parameters:
    
    channels - List of String value for channels.
    
    Returns:
    
    Builder
  - unsetChannels
```
public CatalogItem.Builder unsetChannels()
```
    UnSetter for channels.
    
    Returns:
    
    Builder
  - isArchived
```
public CatalogItem.Builder isArchived(Boolean isArchived)
```
    Setter for isArchived.
    
    Parameters:
    
    isArchived - Boolean value for isArchived.
    
    Returns:
    
    Builder
  - unsetIsArchived
```
public CatalogItem.Builder unsetIsArchived()
```
    UnSetter for isArchived.
    
    Returns:
    
    Builder
  - ecomSeoData
```
public CatalogItem.Builder ecomSeoData(CatalogEcomSeoData ecomSeoData)
```
    Setter for ecomSeoData.
    
    Parameters:
    
    ecomSeoData - CatalogEcomSeoData value for ecomSeoData.
    
    Returns:
    
    Builder
  - foodAndBeverageDetails
```
public CatalogItem.Builder foodAndBeverageDetails(CatalogItemFoodAndBeverageDetails foodAndBeverageDetails)
```
    Setter for foodAndBeverageDetails.
    
    Parameters:
    
    foodAndBeverageDetails - CatalogItemFoodAndBeverageDetails value for foodAndBeverageDetails.
    
    Returns:
    
    Builder
  - reportingCategory
```
public CatalogItem.Builder reportingCategory(CatalogObjectCategory reportingCategory)
```
    Setter for reportingCategory.
    
    Parameters:
    
    reportingCategory - CatalogObjectCategory value for reportingCategory.
    
    Returns:
    
    Builder
  - build
```
public CatalogItem build()
```
    Builds a new CatalogItem object using the set fields.
    
    Returns:
    
    CatalogItem

Class CatalogItem.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

name

unsetName

description

unsetDescription

abbreviation

unsetAbbreviation

labelColor

unsetLabelColor

availableOnline

unsetAvailableOnline

availableForPickup

unsetAvailableForPickup

availableElectronically

unsetAvailableElectronically

categoryId

unsetCategoryId

taxIds

unsetTaxIds

modifierListInfo

unsetModifierListInfo

variations

unsetVariations

productType

skipModifierScreen

unsetSkipModifierScreen

itemOptions

unsetItemOptions

imageIds

unsetImageIds

sortName

unsetSortName

categories

unsetCategories

descriptionHtml

unsetDescriptionHtml

descriptionPlaintext

channels

unsetChannels

isArchived

unsetIsArchived

ecomSeoData

foodAndBeverageDetails

reportingCategory

build