CreateComponentData (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplifyuibuilder.model.CreateComponentData

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateComponentData
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents all of the information that is required to create a component.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateComponentData()

Constructors
Constructor and Description
`CreateComponentData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateComponentData`	`addBindingPropertiesEntry(String key, ComponentBindingPropertiesValue value)` Add a single BindingProperties entry
`CreateComponentData`	`addCollectionPropertiesEntry(String key, ComponentDataConfiguration value)` Add a single CollectionProperties entry
`CreateComponentData`	`addEventsEntry(String key, ComponentEvent value)` Add a single Events entry
`CreateComponentData`	`addOverridesEntry(String key, Map<String,String> value)` Add a single Overrides entry
`CreateComponentData`	`addPropertiesEntry(String key, ComponentProperty value)` Add a single Properties entry
`CreateComponentData`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateComponentData`	`clearBindingPropertiesEntries()` Removes all the entries added into BindingProperties.
`CreateComponentData`	`clearCollectionPropertiesEntries()` Removes all the entries added into CollectionProperties.
`CreateComponentData`	`clearEventsEntries()` Removes all the entries added into Events.
`CreateComponentData`	`clearOverridesEntries()` Removes all the entries added into Overrides.
`CreateComponentData`	`clearPropertiesEntries()` Removes all the entries added into Properties.
`CreateComponentData`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateComponentData`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,ComponentBindingPropertiesValue>`	`getBindingProperties()` The data binding information for the component's properties.
`List<ComponentChild>`	`getChildren()` A list of child components that are instances of the main component.
`Map<String,ComponentDataConfiguration>`	`getCollectionProperties()` The data binding configuration for customizing a component's properties.
`String`	`getComponentType()` The component type.
`Map<String,ComponentEvent>`	`getEvents()` The event configuration for the component.
`String`	`getName()` The name of the component
`Map<String,Map<String,String>>`	`getOverrides()` Describes the component properties that can be overriden to customize an instance of the component.
`Map<String,ComponentProperty>`	`getProperties()` Describes the component's properties.
`String`	`getSchemaVersion()` The schema version of the component when it was imported.
`String`	`getSourceId()` The unique ID of the component in its original source system, such as Figma.
`Map<String,String>`	`getTags()` One or more key-value pairs to use when tagging the component data.
`List<ComponentVariant>`	`getVariants()` A list of the unique variants of this component.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)` The data binding information for the component's properties.
`void`	`setChildren(Collection<ComponentChild> children)` A list of child components that are instances of the main component.
`void`	`setCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)` The data binding configuration for customizing a component's properties.
`void`	`setComponentType(String componentType)` The component type.
`void`	`setEvents(Map<String,ComponentEvent> events)` The event configuration for the component.
`void`	`setName(String name)` The name of the component
`void`	`setOverrides(Map<String,Map<String,String>> overrides)` Describes the component properties that can be overriden to customize an instance of the component.
`void`	`setProperties(Map<String,ComponentProperty> properties)` Describes the component's properties.
`void`	`setSchemaVersion(String schemaVersion)` The schema version of the component when it was imported.
`void`	`setSourceId(String sourceId)` The unique ID of the component in its original source system, such as Figma.
`void`	`setTags(Map<String,String> tags)` One or more key-value pairs to use when tagging the component data.
`void`	`setVariants(Collection<ComponentVariant> variants)` A list of the unique variants of this component.
`String`	`toString()` Returns a string representation of this object.
`CreateComponentData`	`withBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)` The data binding information for the component's properties.
`CreateComponentData`	`withChildren(Collection<ComponentChild> children)` A list of child components that are instances of the main component.
`CreateComponentData`	`withChildren(ComponentChild... children)` A list of child components that are instances of the main component.
`CreateComponentData`	`withCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)` The data binding configuration for customizing a component's properties.
`CreateComponentData`	`withComponentType(String componentType)` The component type.
`CreateComponentData`	`withEvents(Map<String,ComponentEvent> events)` The event configuration for the component.
`CreateComponentData`	`withName(String name)` The name of the component
`CreateComponentData`	`withOverrides(Map<String,Map<String,String>> overrides)` Describes the component properties that can be overriden to customize an instance of the component.
`CreateComponentData`	`withProperties(Map<String,ComponentProperty> properties)` Describes the component's properties.
`CreateComponentData`	`withSchemaVersion(String schemaVersion)` The schema version of the component when it was imported.
`CreateComponentData`	`withSourceId(String sourceId)` The unique ID of the component in its original source system, such as Figma.
`CreateComponentData`	`withTags(Map<String,String> tags)` One or more key-value pairs to use when tagging the component data.
`CreateComponentData`	`withVariants(Collection<ComponentVariant> variants)` A list of the unique variants of this component.
`CreateComponentData`	`withVariants(ComponentVariant... variants)` A list of the unique variants of this component.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateComponentData
```
public CreateComponentData()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the component
    
    Parameters:
    
    name - The name of the component
  - getName
```
public String getName()
```
    The name of the component
    
    Returns:
    
    The name of the component
  - withName
```
public CreateComponentData withName(String name)
```
    The name of the component
    
    Parameters:
    
    name - The name of the component
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceId
```
public void setSourceId(String sourceId)
```
    The unique ID of the component in its original source system, such as Figma.
    
    Parameters:
    
    sourceId - The unique ID of the component in its original source system, such as Figma.
  - getSourceId
```
public String getSourceId()
```
    The unique ID of the component in its original source system, such as Figma.
    
    Returns:
    
    The unique ID of the component in its original source system, such as Figma.
  - withSourceId
```
public CreateComponentData withSourceId(String sourceId)
```
    The unique ID of the component in its original source system, such as Figma.
    
    Parameters:
    
    sourceId - The unique ID of the component in its original source system, such as Figma.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComponentType
```
public void setComponentType(String componentType)
```
    The component type. This can be an Amplify custom UI component or another custom component.
    
    Parameters:
    
    componentType - The component type. This can be an Amplify custom UI component or another custom component.
  - getComponentType
```
public String getComponentType()
```
    The component type. This can be an Amplify custom UI component or another custom component.
    
    Returns:
    
    The component type. This can be an Amplify custom UI component or another custom component.
  - withComponentType
```
public CreateComponentData withComponentType(String componentType)
```
    The component type. This can be an Amplify custom UI component or another custom component.
    
    Parameters:
    
    componentType - The component type. This can be an Amplify custom UI component or another custom component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getProperties
```
public Map<String,ComponentProperty> getProperties()
```
    Describes the component's properties.
    
    Returns:
    
    Describes the component's properties.
  - setProperties
```
public void setProperties(Map<String,ComponentProperty> properties)
```
    Describes the component's properties.
    
    Parameters:
    
    properties - Describes the component's properties.
  - withProperties
```
public CreateComponentData withProperties(Map<String,ComponentProperty> properties)
```
    Describes the component's properties.
    
    Parameters:
    
    properties - Describes the component's properties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addPropertiesEntry
```
public CreateComponentData addPropertiesEntry(String key,
                                              ComponentProperty value)
```
    Add a single Properties entry
    
    See Also:
    
    withProperties(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.ComponentProperty>)
  - clearPropertiesEntries
```
public CreateComponentData clearPropertiesEntries()
```
    Removes all the entries added into Properties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChildren
```
public List<ComponentChild> getChildren()
```
    A list of child components that are instances of the main component.
    
    Returns:
    
    A list of child components that are instances of the main component.
  - setChildren
```
public void setChildren(Collection<ComponentChild> children)
```
    A list of child components that are instances of the main component.
    
    Parameters:
    
    children - A list of child components that are instances of the main component.
  - withChildren
```
public CreateComponentData withChildren(ComponentChild... children)
```
    A list of child components that are instances of the main component.
    
    NOTE: This method appends the values to the existing list (if any). Use setChildren(java.util.Collection) or withChildren(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    children - A list of child components that are instances of the main component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withChildren
```
public CreateComponentData withChildren(Collection<ComponentChild> children)
```
    A list of child components that are instances of the main component.
    
    Parameters:
    
    children - A list of child components that are instances of the main component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVariants
```
public List<ComponentVariant> getVariants()
```
    A list of the unique variants of this component.
    
    Returns:
    
    A list of the unique variants of this component.
  - setVariants
```
public void setVariants(Collection<ComponentVariant> variants)
```
    A list of the unique variants of this component.
    
    Parameters:
    
    variants - A list of the unique variants of this component.
  - withVariants
```
public CreateComponentData withVariants(ComponentVariant... variants)
```
    A list of the unique variants of this component.
    
    NOTE: This method appends the values to the existing list (if any). Use setVariants(java.util.Collection) or withVariants(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    variants - A list of the unique variants of this component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVariants
```
public CreateComponentData withVariants(Collection<ComponentVariant> variants)
```
    A list of the unique variants of this component.
    
    Parameters:
    
    variants - A list of the unique variants of this component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOverrides
```
public Map<String,Map<String,String>> getOverrides()
```
    Describes the component properties that can be overriden to customize an instance of the component.
    
    Returns:
    
    Describes the component properties that can be overriden to customize an instance of the component.
  - setOverrides
```
public void setOverrides(Map<String,Map<String,String>> overrides)
```
    Describes the component properties that can be overriden to customize an instance of the component.
    
    Parameters:
    
    overrides - Describes the component properties that can be overriden to customize an instance of the component.
  - withOverrides
```
public CreateComponentData withOverrides(Map<String,Map<String,String>> overrides)
```
    Describes the component properties that can be overriden to customize an instance of the component.
    
    Parameters:
    
    overrides - Describes the component properties that can be overriden to customize an instance of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addOverridesEntry
```
public CreateComponentData addOverridesEntry(String key,
                                             Map<String,String> value)
```
    Add a single Overrides entry
    
    See Also:
    
    withOverrides(java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>)
  - clearOverridesEntries
```
public CreateComponentData clearOverridesEntries()
```
    Removes all the entries added into Overrides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBindingProperties
```
public Map<String,ComponentBindingPropertiesValue> getBindingProperties()
```
    The data binding information for the component's properties.
    
    Returns:
    
    The data binding information for the component's properties.
  - setBindingProperties
```
public void setBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)
```
    The data binding information for the component's properties.
    
    Parameters:
    
    bindingProperties - The data binding information for the component's properties.
  - withBindingProperties
```
public CreateComponentData withBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)
```
    The data binding information for the component's properties.
    
    Parameters:
    
    bindingProperties - The data binding information for the component's properties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addBindingPropertiesEntry
```
public CreateComponentData addBindingPropertiesEntry(String key,
                                                     ComponentBindingPropertiesValue value)
```
    Add a single BindingProperties entry
    
    See Also:
    
    withBindingProperties(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValue>)
  - clearBindingPropertiesEntries
```
public CreateComponentData clearBindingPropertiesEntries()
```
    Removes all the entries added into BindingProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCollectionProperties
```
public Map<String,ComponentDataConfiguration> getCollectionProperties()
```
    The data binding configuration for customizing a component's properties. Use this for a collection component.
    
    Returns:
    
    The data binding configuration for customizing a component's properties. Use this for a collection component.
  - setCollectionProperties
```
public void setCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)
```
    The data binding configuration for customizing a component's properties. Use this for a collection component.
    
    Parameters:
    
    collectionProperties - The data binding configuration for customizing a component's properties. Use this for a collection component.
  - withCollectionProperties
```
public CreateComponentData withCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)
```
    The data binding configuration for customizing a component's properties. Use this for a collection component.
    
    Parameters:
    
    collectionProperties - The data binding configuration for customizing a component's properties. Use this for a collection component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addCollectionPropertiesEntry
```
public CreateComponentData addCollectionPropertiesEntry(String key,
                                                        ComponentDataConfiguration value)
```
    Add a single CollectionProperties entry
    
    See Also:
    
    withCollectionProperties(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.ComponentDataConfiguration>)
  - clearCollectionPropertiesEntries
```
public CreateComponentData clearCollectionPropertiesEntries()
```
    Removes all the entries added into CollectionProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    One or more key-value pairs to use when tagging the component data.
    
    Returns:
    
    One or more key-value pairs to use when tagging the component data.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the component data.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the component data.
  - withTags
```
public CreateComponentData withTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the component data.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the component data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateComponentData addTagsEntry(String key,
                                        String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateComponentData clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEvents
```
public Map<String,ComponentEvent> getEvents()
```
    The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    
    Returns:
    
    The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
  - setEvents
```
public void setEvents(Map<String,ComponentEvent> events)
```
    The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    
    Parameters:
    
    events - The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
  - withEvents
```
public CreateComponentData withEvents(Map<String,ComponentEvent> events)
```
    The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    
    Parameters:
    
    events - The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEventsEntry
```
public CreateComponentData addEventsEntry(String key,
                                          ComponentEvent value)
```
    Add a single Events entry
    
    See Also:
    
    withEvents(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.ComponentEvent>)
  - clearEventsEntries
```
public CreateComponentData clearEventsEntries()
```
    Removes all the entries added into Events.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchemaVersion
```
public void setSchemaVersion(String schemaVersion)
```
    The schema version of the component when it was imported.
    
    Parameters:
    
    schemaVersion - The schema version of the component when it was imported.
  - getSchemaVersion
```
public String getSchemaVersion()
```
    The schema version of the component when it was imported.
    
    Returns:
    
    The schema version of the component when it was imported.
  - withSchemaVersion
```
public CreateComponentData withSchemaVersion(String schemaVersion)
```
    The schema version of the component when it was imported.
    
    Parameters:
    
    schemaVersion - The schema version of the component when it was imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateComponentData clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CreateComponentData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateComponentData

Method Detail

setName

getName

withName

setSourceId

getSourceId

withSourceId

setComponentType

getComponentType

withComponentType

getProperties

setProperties

withProperties

addPropertiesEntry

clearPropertiesEntries

getChildren

setChildren

withChildren

withChildren

getVariants

setVariants

withVariants

withVariants

getOverrides

setOverrides

withOverrides

addOverridesEntry

clearOverridesEntries

getBindingProperties

setBindingProperties

withBindingProperties

addBindingPropertiesEntry

clearBindingPropertiesEntries

getCollectionProperties

setCollectionProperties

withCollectionProperties

addCollectionPropertiesEntry

clearCollectionPropertiesEntries

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getEvents

setEvents

withEvents

addEventsEntry

clearEventsEntries

setSchemaVersion

getSchemaVersion

withSchemaVersion

toString

equals

hashCode

clone

marshall