Struct CustomAttributeDefinition 

pub struct CustomAttributeDefinition {
    pub key: Option<Option<String>>,
    pub schema: Option<Option<Value>>,
    pub name: Option<Option<String>>,
    pub description: Option<Option<String>>,
    pub visibility: Option<CustomAttributeDefinitionVisibility>,
    pub version: Option<i32>,
    pub updated_at: Option<String>,
    pub created_at: Option<String>,
}

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

Fields

key: Option<Option<String>>

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.

schema: Option<Option<Value>>

The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information, see Custom Attributes Overview. This field is required when creating a definition.

name: Option<Option<String>>

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.

description: Option<Option<String>>

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.

visibility: Option<CustomAttributeDefinitionVisibility>

version: Option<i32>

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. 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.

updated_at: Option<String>

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

created_at: Option<String>

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

Implementations

impl CustomAttributeDefinition

pub fn new() -> CustomAttributeDefinition

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

Trait Implementations

impl Clone for CustomAttributeDefinition

fn clone(&self) -> CustomAttributeDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomAttributeDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CustomAttributeDefinition

fn default() -> CustomAttributeDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomAttributeDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CustomAttributeDefinition

fn eq(&self, other: &CustomAttributeDefinition) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CustomAttributeDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CustomAttributeDefinition