com.squareup.square.models

Class CustomAttributeDefinition

java.lang.Object

com.squareup.square.models.CustomAttributeDefinition

public class CustomAttributeDefinition
extends Object

This is a model class for CustomAttributeDefinition type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CustomAttributeDefinition(String key, JsonObject schema, String name, String description, SourceApplication sourceApplication, String visibility, Integer version, String updatedAt, String createdAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCreatedAt() Getter for CreatedAt.
String	getDescription() Getter for Description.
String	getKey() Getter for Key.
String	getName() Getter for Name.
JsonObject	getSchema() Getter for Schema.
SourceApplication	getSourceApplication() Getter for SourceApplication.
String	getUpdatedAt() Getter for UpdatedAt.
Integer	getVersion() Getter for Version.
String	getVisibility() Getter for Visibility.
int	hashCode()
CustomAttributeDefinition.Builder	toBuilder() Builds a new CustomAttributeDefinition.Builder object.
String	toString() Converts this CustomAttributeDefinition into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomAttributeDefinition

public CustomAttributeDefinition(String key,
                                 JsonObject schema,
                                 String name,
                                 String description,
                                 SourceApplication sourceApplication,
                                 String visibility,
                                 Integer version,
                                 String updatedAt,
                                 String createdAt)

Initialization constructor.

Parameters:

key - String value for key.

schema - JsonObject value for schema.

name - String value for name.

description - String value for description.

sourceApplication - SourceApplication value for sourceApplication.

visibility - String value for visibility.

version - Integer value for version.

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 (-). This field can not be changed after the custom attribute definition is created. This field is required when creating a definition and must be unique per application, seller, and resource type.

Returns:

Returns the String

getSchema

public JsonObject getSchema()

Getter for Schema. The JSON schema for the custom attribute definition. For more information about the schema, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).

Returns:

Returns the JsonObject

getName

public String getName()

Getter for Name. The name of the custom attribute definition for API and seller-facing UI purposes. The name must be unique within the seller and application pair. This field is required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. Seller-oriented description of the custom attribute definition, including any constraints that the seller should observe. May be displayed as a tooltip in Square UIs. This field is required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.

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

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

getVersion

public Integer getVersion()

Getter for Version. Read only. The current version of the custom attribute definition. The value is incremented each time the custom attribute definition is updated. When updating a custom attribute definition, you can provide this field and specify the current version of the custom attribute definition to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). On writes, this field must be set to the latest version. Stale writes are rejected. 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

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp that indicates when the custom attribute definition was created or 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 definition 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 CustomAttributeDefinition into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CustomAttributeDefinition.Builder toBuilder()

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

Returns:

a new CustomAttributeDefinition.Builder object