Struct UpdateComponentData 

#[non_exhaustive]
pub struct UpdateComponentData {
    pub id: Option<String>,
    pub name: Option<String>,
    pub source_id: Option<String>,
    pub component_type: Option<String>,
    pub properties: Option<HashMap<String, ComponentProperty>>,
    pub children: Option<Vec<ComponentChild>>,
    pub variants: Option<Vec<ComponentVariant>>,
    pub overrides: Option<HashMap<String, HashMap<String, String>>>,
    pub binding_properties: Option<HashMap<String, ComponentBindingPropertiesValue>>,
    pub collection_properties: Option<HashMap<String, ComponentDataConfiguration>>,
    pub events: Option<HashMap<String, ComponentEvent>>,
    pub schema_version: Option<String>,
}

Updates and saves all of the information about a component, based on component ID.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The unique ID of the component to update.

name: Option<String>

The name of the component to update.

source_id: Option<String>

The unique ID of the component in its original source system, such as Figma.

component_type: Option<String>

The type of the component. This can be an Amplify custom UI component or another custom component.

properties: Option<HashMap<String, ComponentProperty>>

Describes the component's properties.

children: Option<Vec<ComponentChild>>

The components that are instances of the main component.

variants: Option<Vec<ComponentVariant>>

A list of the unique variants of the main component being updated.

overrides: Option<HashMap<String, HashMap<String, String>>>

Describes the properties that can be overriden to customize the component.

binding_properties: Option<HashMap<String, ComponentBindingPropertiesValue>>

The data binding information for the component's properties.

collection_properties: Option<HashMap<String, ComponentDataConfiguration>>

The configuration for binding a component's properties to a data model. Use this for a collection component.

events: Option<HashMap<String, ComponentEvent>>

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

schema_version: Option<String>

The schema version of the component when it was imported.

Implementations

impl UpdateComponentData

pub fn id(&self) -> Option<&str>

The unique ID of the component to update.

pub fn name(&self) -> Option<&str>

The name of the component to update.

pub fn source_id(&self) -> Option<&str>

The unique ID of the component in its original source system, such as Figma.

pub fn component_type(&self) -> Option<&str>

The type of the component. This can be an Amplify custom UI component or another custom component.

pub fn properties(&self) -> Option<&HashMap<String, ComponentProperty>>

Describes the component's properties.

pub fn children(&self) -> &[ComponentChild]

The components that are instances of the main component.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .children.is_none().

pub fn variants(&self) -> &[ComponentVariant]

A list of the unique variants of the main component being updated.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .variants.is_none().

pub fn overrides(&self) -> Option<&HashMap<String, HashMap<String, String>>>

Describes the properties that can be overriden to customize the component.

pub fn binding_properties( &self, ) -> Option<&HashMap<String, ComponentBindingPropertiesValue>>

The data binding information for the component's properties.

pub fn collection_properties( &self, ) -> Option<&HashMap<String, ComponentDataConfiguration>>

The configuration for binding a component's properties to a data model. Use this for a collection component.

pub fn events(&self) -> Option<&HashMap<String, ComponentEvent>>

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

pub fn schema_version(&self) -> Option<&str>

The schema version of the component when it was imported.

impl UpdateComponentData

pub fn builder() -> UpdateComponentDataBuilder

Creates a new builder-style object to manufacture UpdateComponentData.

Trait Implementations

impl Clone for UpdateComponentData

fn clone(&self) -> UpdateComponentData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateComponentData

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

Formats the value using the given formatter.

impl PartialEq for UpdateComponentData

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateComponentData