com.squareup.square.models

Class CatalogCustomAttributeDefinition

java.lang.Object

com.squareup.square.models.CatalogCustomAttributeDefinition

public class CatalogCustomAttributeDefinition
extends Object

This is a model class for CatalogCustomAttributeDefinition type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogCustomAttributeDefinition.Builder Class to build instances of CatalogCustomAttributeDefinition.

Constructor Summary

Constructors

Constructor and Description

CatalogCustomAttributeDefinition(String type, String name, List<String> allowedObjectTypes, String description, SourceApplication sourceApplication, String sellerVisibility, String appVisibility, CatalogCustomAttributeDefinitionStringConfig stringConfig, CatalogCustomAttributeDefinitionNumberConfig numberConfig, CatalogCustomAttributeDefinitionSelectionConfig selectionConfig, Integer customAttributeUsageCount, String key) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAllowedObjectTypes() Getter for AllowedObjectTypes.
String	getAppVisibility() Getter for AppVisibility.
Integer	getCustomAttributeUsageCount() Getter for CustomAttributeUsageCount.
String	getDescription() Getter for Description.
String	getKey() Getter for Key.
String	getName() Getter for Name.
CatalogCustomAttributeDefinitionNumberConfig	getNumberConfig() Getter for NumberConfig.
CatalogCustomAttributeDefinitionSelectionConfig	getSelectionConfig() Getter for SelectionConfig.
String	getSellerVisibility() Getter for SellerVisibility.
SourceApplication	getSourceApplication() Getter for SourceApplication.
CatalogCustomAttributeDefinitionStringConfig	getStringConfig() Getter for StringConfig.
String	getType() Getter for Type.
int	hashCode()
CatalogCustomAttributeDefinition.Builder	toBuilder() Builds a new CatalogCustomAttributeDefinition.Builder object.
String	toString() Converts this CatalogCustomAttributeDefinition into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CatalogCustomAttributeDefinition

public CatalogCustomAttributeDefinition(String type,
                                        String name,
                                        List<String> allowedObjectTypes,
                                        String description,
                                        SourceApplication sourceApplication,
                                        String sellerVisibility,
                                        String appVisibility,
                                        CatalogCustomAttributeDefinitionStringConfig stringConfig,
                                        CatalogCustomAttributeDefinitionNumberConfig numberConfig,
                                        CatalogCustomAttributeDefinitionSelectionConfig selectionConfig,
                                        Integer customAttributeUsageCount,
                                        String key)

Initialization constructor.

Parameters:

type - String value for type.

name - String value for name.

allowedObjectTypes - List of String value for allowedObjectTypes.

description - String value for description.

sourceApplication - SourceApplication value for sourceApplication.

sellerVisibility - String value for sellerVisibility.

appVisibility - String value for appVisibility.

stringConfig - CatalogCustomAttributeDefinitionStringConfig value for stringConfig.

numberConfig - CatalogCustomAttributeDefinitionNumberConfig value for numberConfig.

selectionConfig - CatalogCustomAttributeDefinitionSelectionConfig value for selectionConfig.

customAttributeUsageCount - Integer value for customAttributeUsageCount.

key - String value for key.

Method Detail

getType

public String getType()

Getter for Type. Defines the possible types for a custom attribute.

Returns:

Returns the String

getName

public String getName()

Getter for Name. The name of this definition for API and seller-facing UI purposes. The name must be unique within the (merchant, application) pair. Required. May not be empty and may not exceed 255 characters. Can be modified after creation.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. Seller-oriented description of the meaning of this Custom Attribute, any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.

Returns:

Returns the String

getSourceApplication

public SourceApplication getSourceApplication()

Getter for SourceApplication. Represents information about the application used to generate a change.

Returns:

Returns the SourceApplication

getAllowedObjectTypes

public List<String> getAllowedObjectTypes()

Getter for AllowedObjectTypes. The set of Catalog Object Types that this Custom Attribute may be applied to. Currently, only `ITEM` and `ITEM_VARIATION` are allowed. At least one type must be included. See [CatalogObjectType](#type-catalogobjecttype) for possible values

Returns:

Returns the List of String

getSellerVisibility

public String getSellerVisibility()

Getter for SellerVisibility. Defines the visibility of a custom attribute to sellers in Square client applications, Square APIs or in Square UIs (including Square Point of Sale applications and Square Dashboard).

Returns:

Returns the String

getAppVisibility

public String getAppVisibility()

Getter for AppVisibility. Defines the visibility of a custom attribute to applications other than their creating application.

Returns:

Returns the String

getStringConfig

public CatalogCustomAttributeDefinitionStringConfig getStringConfig()

Getter for StringConfig. Configuration associated with Custom Attribute Definitions of type `STRING`.

Returns:

Returns the CatalogCustomAttributeDefinitionStringConfig

getNumberConfig

public CatalogCustomAttributeDefinitionNumberConfig getNumberConfig()

Getter for NumberConfig.

Returns:

Returns the CatalogCustomAttributeDefinitionNumberConfig

getSelectionConfig

public CatalogCustomAttributeDefinitionSelectionConfig getSelectionConfig()

Getter for SelectionConfig. Configuration associated with `SELECTION`-type custom attribute definitions.

Returns:

Returns the CatalogCustomAttributeDefinitionSelectionConfig

getCustomAttributeUsageCount

public Integer getCustomAttributeUsageCount()

Getter for CustomAttributeUsageCount. The number of custom attributes that reference this custom attribute definition. Set by the server in response to a ListCatalog request with `include_counts` set to `true`. If the actual count is greater than 100, `custom_attribute_usage_count` will be set to `100`.

Returns:

Returns the Integer

getKey

public String getKey()

Getter for Key. The name of the desired custom attribute key that can be used to access the custom attribute value on catalog objects. Cannot be modified after the custom attribute definition has been created. Must be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CatalogCustomAttributeDefinition into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogCustomAttributeDefinition.Builder toBuilder()

Builds a new CatalogCustomAttributeDefinition.Builder object. Creates the instance with the state of the current model.

Returns:

a new CatalogCustomAttributeDefinition.Builder object