Component (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Component
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Component`	`addBindingPropertiesEntry(String key, ComponentBindingPropertiesValue value)` Add a single BindingProperties entry
`Component`	`addCollectionPropertiesEntry(String key, ComponentDataConfiguration value)` Add a single CollectionProperties entry
`Component`	`addOverridesEntry(String key, Map<String,String> value)` Add a single Overrides entry
`Component`	`addPropertiesEntry(String key, ComponentProperty value)` Add a single Properties entry
`Component`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Component`	`clearBindingPropertiesEntries()` Removes all the entries added into BindingProperties.
`Component`	`clearCollectionPropertiesEntries()` Removes all the entries added into CollectionProperties.
`Component`	`clearOverridesEntries()` Removes all the entries added into Overrides.
`Component`	`clearPropertiesEntries()` Removes all the entries added into Properties.
`Component`	`clearTagsEntries()` Removes all the entries added into Tags.
`Component`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAppId()` The unique ID of the Amplify app associated with the component.
`Map<String,ComponentBindingPropertiesValue>`	`getBindingProperties()` The information to connect a component's properties to data at runtime.
`List<ComponentChild>`	`getChildren()` A list of the component's `ComponentChild` instances.
`Map<String,ComponentDataConfiguration>`	`getCollectionProperties()` The data binding configuration for the component's properties.
`String`	`getComponentType()` The type of the component.
`Date`	`getCreatedAt()` The time that the component was created.
`String`	`getEnvironmentName()` The name of the backend environment that is a part of the Amplify app.
`String`	`getId()` The unique ID of the component.
`Date`	`getModifiedAt()` The time that the component was modified.
`String`	`getName()` The name of the component.
`Map<String,Map<String,String>>`	`getOverrides()` Describes the component's properties that can be overriden in a customized instance of the component.
`Map<String,ComponentProperty>`	`getProperties()` Describes the component's properties.
`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.
`List<ComponentVariant>`	`getVariants()` A list of the component's variants.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAppId(String appId)` The unique ID of the Amplify app associated with the component.
`void`	`setBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)` The information to connect a component's properties to data at runtime.
`void`	`setChildren(Collection<ComponentChild> children)` A list of the component's `ComponentChild` instances.
`void`	`setCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)` The data binding configuration for the component's properties.
`void`	`setComponentType(String componentType)` The type of the component.
`void`	`setCreatedAt(Date createdAt)` The time that the component was created.
`void`	`setEnvironmentName(String environmentName)` The name of the backend environment that is a part of the Amplify app.
`void`	`setId(String id)` The unique ID of the component.
`void`	`setModifiedAt(Date modifiedAt)` The time that the component was modified.
`void`	`setName(String name)` The name of the component.
`void`	`setOverrides(Map<String,Map<String,String>> overrides)` Describes the component's properties that can be overriden in a customized instance of the component.
`void`	`setProperties(Map<String,ComponentProperty> properties)` Describes the component's properties.
`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.
`void`	`setVariants(Collection<ComponentVariant> variants)` A list of the component's variants.
`String`	`toString()` Returns a string representation of this object.
`Component`	`withAppId(String appId)` The unique ID of the Amplify app associated with the component.
`Component`	`withBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)` The information to connect a component's properties to data at runtime.
`Component`	`withChildren(Collection<ComponentChild> children)` A list of the component's `ComponentChild` instances.
`Component`	`withChildren(ComponentChild... children)` A list of the component's `ComponentChild` instances.
`Component`	`withCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)` The data binding configuration for the component's properties.
`Component`	`withComponentType(String componentType)` The type of the component.
`Component`	`withCreatedAt(Date createdAt)` The time that the component was created.
`Component`	`withEnvironmentName(String environmentName)` The name of the backend environment that is a part of the Amplify app.
`Component`	`withId(String id)` The unique ID of the component.
`Component`	`withModifiedAt(Date modifiedAt)` The time that the component was modified.
`Component`	`withName(String name)` The name of the component.
`Component`	`withOverrides(Map<String,Map<String,String>> overrides)` Describes the component's properties that can be overriden in a customized instance of the component.
`Component`	`withProperties(Map<String,ComponentProperty> properties)` Describes the component's properties.
`Component`	`withSourceId(String sourceId)` The unique ID of the component in its original source system, such as Figma.
`Component`	`withTags(Map<String,String> tags)` One or more key-value pairs to use when tagging the component.
`Component`	`withVariants(Collection<ComponentVariant> variants)` A list of the component's variants.
`Component`	`withVariants(ComponentVariant... variants)` A list of the component's variants.

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

- Constructor Detail
  - Component
```
public Component()
```
- Method Detail
  - setAppId
```
public void setAppId(String appId)
```
    The unique ID of the Amplify app associated with the component.
    
    Parameters:
    
    appId - The unique ID of the Amplify app associated with the component.
  - getAppId
```
public String getAppId()
```
    The unique ID of the Amplify app associated with the component.
    
    Returns:
    
    The unique ID of the Amplify app associated with the component.
  - withAppId
```
public Component withAppId(String appId)
```
    The unique ID of the Amplify app associated with the component.
    
    Parameters:
    
    appId - The unique ID of the Amplify app associated with the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBindingProperties
```
public Map<String,ComponentBindingPropertiesValue> getBindingProperties()
```
    The information to connect a component's properties to data at runtime.
    
    Returns:
    
    The information to connect a component's properties to data at runtime.
  - setBindingProperties
```
public void setBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)
```
    The information to connect a component's properties to data at runtime.
    
    Parameters:
    
    bindingProperties - The information to connect a component's properties to data at runtime.
  - withBindingProperties
```
public Component withBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)
```
    The information to connect a component's properties to data at runtime.
    
    Parameters:
    
    bindingProperties - The information to connect a component's properties to data at runtime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addBindingPropertiesEntry
```
public Component 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 Component clearBindingPropertiesEntries()
```
    Removes all the entries added into BindingProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChildren
```
public List<ComponentChild> getChildren()
```
    A list of the component's ComponentChild instances.
    
    Returns:
    
    A list of the component's ComponentChild instances.
  - setChildren
```
public void setChildren(Collection<ComponentChild> children)
```
    A list of the component's ComponentChild instances.
    
    Parameters:
    
    children - A list of the component's ComponentChild instances.
  - withChildren
```
public Component withChildren(ComponentChild... children)
```
    A list of the component's ComponentChild instances.
    
    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 the component's ComponentChild instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withChildren
```
public Component withChildren(Collection<ComponentChild> children)
```
    A list of the component's ComponentChild instances.
    
    Parameters:
    
    children - A list of the component's ComponentChild instances.
    
    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 the component's properties. Use this for a collection component.
    
    Returns:
    
    The data binding configuration for the component's properties. Use this for a collection component.
  - setCollectionProperties
```
public void setCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)
```
    The data binding configuration for the component's properties. Use this for a collection component.
    
    Parameters:
    
    collectionProperties - The data binding configuration for the component's properties. Use this for a collection component.
  - withCollectionProperties
```
public Component withCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)
```
    The data binding configuration for the component's properties. Use this for a collection component.
    
    Parameters:
    
    collectionProperties - The data binding configuration for the 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 Component 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 Component clearCollectionPropertiesEntries()
```
    Removes all the entries added into CollectionProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComponentType
```
public void setComponentType(String componentType)
```
    The type of the component. This can be an Amplify custom UI component or another custom component.
    
    Parameters:
    
    componentType - The type of the component. This can be an Amplify custom UI component or another custom component.
  - getComponentType
```
public String getComponentType()
```
    The type of the component. This can be an Amplify custom UI component or another custom component.
    
    Returns:
    
    The type of the component. This can be an Amplify custom UI component or another custom component.
  - withComponentType
```
public Component withComponentType(String componentType)
```
    The type of the component. This can be an Amplify custom UI component or another custom component.
    
    Parameters:
    
    componentType - The type of the component. 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.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time that the component was created.
    
    Parameters:
    
    createdAt - The time that the component was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time that the component was created.
    
    Returns:
    
    The time that the component was created.
  - withCreatedAt
```
public Component withCreatedAt(Date createdAt)
```
    The time that the component was created.
    
    Parameters:
    
    createdAt - The time that the component was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentName
```
public void setEnvironmentName(String environmentName)
```
    The name of the backend environment that is a part of the Amplify app.
    
    Parameters:
    
    environmentName - The name of the backend environment that is a part of the Amplify app.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    The name of the backend environment that is a part of the Amplify app.
    
    Returns:
    
    The name of the backend environment that is a part of the Amplify app.
  - withEnvironmentName
```
public Component withEnvironmentName(String environmentName)
```
    The name of the backend environment that is a part of the Amplify app.
    
    Parameters:
    
    environmentName - The name of the backend environment that is a part of the Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique ID of the component.
    
    Parameters:
    
    id - The unique ID of the component.
  - getId
```
public String getId()
```
    The unique ID of the component.
    
    Returns:
    
    The unique ID of the component.
  - withId
```
public Component withId(String id)
```
    The unique ID of the component.
    
    Parameters:
    
    id - The unique ID of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModifiedAt
```
public void setModifiedAt(Date modifiedAt)
```
    The time that the component was modified.
    
    Parameters:
    
    modifiedAt - The time that the component was modified.
  - getModifiedAt
```
public Date getModifiedAt()
```
    The time that the component was modified.
    
    Returns:
    
    The time that the component was modified.
  - withModifiedAt
```
public Component withModifiedAt(Date modifiedAt)
```
    The time that the component was modified.
    
    Parameters:
    
    modifiedAt - The time that the component was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Component 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.
  - getOverrides
```
public Map<String,Map<String,String>> getOverrides()
```
    Describes the component's properties that can be overriden in a customized instance of the component.
    
    Returns:
    
    Describes the component's properties that can be overriden in a customized instance of the component.
  - setOverrides
```
public void setOverrides(Map<String,Map<String,String>> overrides)
```
    Describes the component's properties that can be overriden in a customized instance of the component.
    
    Parameters:
    
    overrides - Describes the component's properties that can be overriden in a customized instance of the component.
  - withOverrides
```
public Component withOverrides(Map<String,Map<String,String>> overrides)
```
    Describes the component's properties that can be overriden in a customized instance of the component.
    
    Parameters:
    
    overrides - Describes the component's properties that can be overriden in a customized instance of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addOverridesEntry
```
public Component 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 Component clearOverridesEntries()
```
    Removes all the entries added into Overrides.
    
    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 Component 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 Component 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 Component clearPropertiesEntries()
```
    Removes all the entries added into Properties.
    
    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 Component 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.
  - getTags
```
public Map<String,String> getTags()
```
    One or more key-value pairs to use when tagging the component.
    
    Returns:
    
    One or more key-value pairs to use when tagging the component.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the component.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the component.
  - withTags
```
public Component withTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the component.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Component addTagsEntry(String key,
                              String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Component clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVariants
```
public List<ComponentVariant> getVariants()
```
    A list of the component's variants. A variant is a unique style configuration of a main component.
    
    Returns:
    
    A list of the component's variants. A variant is a unique style configuration of a main component.
  - setVariants
```
public void setVariants(Collection<ComponentVariant> variants)
```
    A list of the component's variants. A variant is a unique style configuration of a main component.
    
    Parameters:
    
    variants - A list of the component's variants. A variant is a unique style configuration of a main component.
  - withVariants
```
public Component withVariants(ComponentVariant... variants)
```
    A list of the component's variants. A variant is a unique style configuration of a main 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 component's variants. A variant is a unique style configuration of a main component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVariants
```
public Component withVariants(Collection<ComponentVariant> variants)
```
    A list of the component's variants. A variant is a unique style configuration of a main component.
    
    Parameters:
    
    variants - A list of the component's variants. A variant is a unique style configuration of a main component.
    
    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 Component 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 Component

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Component

Method Detail

setAppId

getAppId

withAppId

getBindingProperties

setBindingProperties

withBindingProperties

addBindingPropertiesEntry

clearBindingPropertiesEntries

getChildren

setChildren

withChildren

withChildren

getCollectionProperties

setCollectionProperties

withCollectionProperties

addCollectionPropertiesEntry

clearCollectionPropertiesEntries

setComponentType

getComponentType

withComponentType

setCreatedAt

getCreatedAt

withCreatedAt

setEnvironmentName

getEnvironmentName

withEnvironmentName

setId

getId

withId

setModifiedAt

getModifiedAt

withModifiedAt

setName

getName

withName

getOverrides

setOverrides

withOverrides

addOverridesEntry

clearOverridesEntries

getProperties

setProperties

withProperties

addPropertiesEntry

clearPropertiesEntries

setSourceId

getSourceId

withSourceId

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getVariants

setVariants

withVariants

withVariants

toString

equals

hashCode

clone

marshall