com.squareup.square.models

Class CustomAttribute

java.lang.Object

com.squareup.square.models.CustomAttribute

public class CustomAttribute
extends Object

This is a model class for CustomAttribute type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CustomAttribute(String key, JsonValue value, Integer version, String visibility, CustomAttributeDefinition definition, String updatedAt, String createdAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCreatedAt() Getter for CreatedAt.
CustomAttributeDefinition	getDefinition() Getter for Definition.
String	getKey() Getter for Key.
String	getUpdatedAt() Getter for UpdatedAt.
JsonValue	getValue() Getter for Value.
Integer	getVersion() Getter for Version.
String	getVisibility() Getter for Visibility.
int	hashCode()
CustomAttribute.Builder	toBuilder() Builds a new CustomAttribute.Builder object.
String	toString() Converts this CustomAttribute into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomAttribute

public CustomAttribute(String key,
                       JsonValue value,
                       Integer version,
                       String visibility,
                       CustomAttributeDefinition definition,
                       String updatedAt,
                       String createdAt)

Initialization constructor.

Parameters:

key - String value for key.

value - JsonValue value for value.

version - Integer value for version.

visibility - String value for visibility.

definition - CustomAttributeDefinition value for definition.

updatedAt - String value for updatedAt.

createdAt - String value for createdAt.

Method Detail

getKey

public String getKey()

Getter for Key. The identifier of the custom attribute definition and its corresponding custom attributes. This value can be a simple key, which is the key that is provided when the custom attribute definition is created, or a qualified key, if the requesting application is not the definition owner. The qualified key consists of the application ID of the custom attribute definition owner followed by the simple key that was provided when the definition was created. It has the format application_id:simple key. The value for a simple key can contain up to 60 alphanumeric characters, periods (.), underscores (_), and hyphens (-).

Returns:

Returns the String

getValue

public JsonValue getValue()

Getter for Value. The value assigned to the custom attribute. It is validated against the custom attribute definition's schema on write operations. For more information about custom attribute values, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).

Returns:

Returns the JsonValue

getVersion

public Integer getVersion()

Getter for Version. Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed. When updating an existing custom attribute value, you can provide this field and specify the current version of the custom attribute to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).

Returns:

Returns the Integer

getVisibility

public String getVisibility()

Getter for Visibility. The level of permission that a seller or other applications requires to view this custom attribute definition. The `Visibility` field controls who can read and write the custom attribute values and custom attribute definition.

Returns:

Returns the String

getDefinition

public CustomAttributeDefinition getDefinition()

Getter for Definition. Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute.

Returns:

Returns the CustomAttributeDefinition

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp that indicates when the custom attribute was created or was most recently updated, in RFC 3339 format.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp that indicates when the custom attribute was created, in RFC 3339 format.

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 CustomAttribute into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CustomAttribute.Builder toBuilder()

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

Returns:

a new CustomAttribute.Builder object