@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
.
Constructor and Description |
---|
Component() |
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 |
addEventsEntry(String key,
ComponentEvent value)
Add a single Events 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 |
clearEventsEntries()
Removes all the entries added into Events.
|
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.
|
Map<String,ComponentEvent> |
getEvents()
Describes the events that can be raised on the component.
|
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 |
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.
|
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 |
setEvents(Map<String,ComponentEvent> events)
Describes the events that can be raised on the component.
|
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 |
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.
|
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 |
withEvents(Map<String,ComponentEvent> events)
Describes the events that can be raised on the component.
|
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 |
withSchemaVersion(String schemaVersion)
The schema version of the component when it was imported.
|
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.
|
public void setAppId(String appId)
The unique ID of the Amplify app associated with the component.
appId
- The unique ID of the Amplify app associated with the component.public String getAppId()
The unique ID of the Amplify app associated with the component.
public Component withAppId(String appId)
The unique ID of the Amplify app associated with the component.
appId
- The unique ID of the Amplify app associated with the component.public void setEnvironmentName(String environmentName)
The name of the backend environment that is a part of the Amplify app.
environmentName
- The name of the backend environment that is a part of the Amplify app.public String getEnvironmentName()
The name of the backend environment that is a part of the Amplify app.
public Component withEnvironmentName(String environmentName)
The name of the backend environment that is a part of the Amplify app.
environmentName
- The name of the backend environment that is a part of the Amplify app.public void setSourceId(String sourceId)
The unique ID of the component in its original source system, such as Figma.
sourceId
- The unique ID of the component in its original source system, such as Figma.public String getSourceId()
The unique ID of the component in its original source system, such as Figma.
public Component withSourceId(String sourceId)
The unique ID of the component in its original source system, such as Figma.
sourceId
- The unique ID of the component in its original source system, such as Figma.public void setId(String id)
The unique ID of the component.
id
- The unique ID of the component.public String getId()
The unique ID of the component.
public Component withId(String id)
The unique ID of the component.
id
- The unique ID of the component.public void setName(String name)
The name of the component.
name
- The name of the component.public String getName()
The name of the component.
public Component withName(String name)
The name of the component.
name
- The name of the component.public void setComponentType(String componentType)
The type of the component. This can be an Amplify custom UI component or another custom component.
componentType
- The type of the component. This can be an Amplify custom UI component or another custom component.public String getComponentType()
The type of the component. This can be an Amplify custom UI component or another custom component.
public Component withComponentType(String componentType)
The type of the component. This can be an Amplify custom UI component or another custom component.
componentType
- The type of the component. This can be an Amplify custom UI component or another custom component.public Map<String,ComponentProperty> getProperties()
Describes the component's properties. You can't specify tags
as a valid property for
properties
.
tags
as a valid property for
properties
.public void setProperties(Map<String,ComponentProperty> properties)
Describes the component's properties. You can't specify tags
as a valid property for
properties
.
properties
- Describes the component's properties. You can't specify tags
as a valid property for
properties
.public Component withProperties(Map<String,ComponentProperty> properties)
Describes the component's properties. You can't specify tags
as a valid property for
properties
.
properties
- Describes the component's properties. You can't specify tags
as a valid property for
properties
.public Component addPropertiesEntry(String key, ComponentProperty value)
public Component clearPropertiesEntries()
public List<ComponentChild> getChildren()
A list of the component's ComponentChild
instances.
ComponentChild
instances.public void setChildren(Collection<ComponentChild> children)
A list of the component's ComponentChild
instances.
children
- A list of the component's ComponentChild
instances.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.
children
- A list of the component's ComponentChild
instances.public Component withChildren(Collection<ComponentChild> children)
A list of the component's ComponentChild
instances.
children
- A list of the component's ComponentChild
instances.public List<ComponentVariant> getVariants()
A list of the component's variants. A variant is a unique style configuration of a main component.
public void setVariants(Collection<ComponentVariant> variants)
A list of the component's variants. A variant is a unique style configuration of a main component.
variants
- A list of the component's variants. A variant is a unique style configuration of a main component.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.
variants
- A list of the component's variants. A variant is a unique style configuration of a main component.public Component withVariants(Collection<ComponentVariant> variants)
A list of the component's variants. A variant is a unique style configuration of a main component.
variants
- A list of the component's variants. A variant is a unique style configuration of a main component.public Map<String,Map<String,String>> getOverrides()
Describes the component's properties that can be overriden in a customized instance of the component. You can't
specify tags
as a valid property for overrides
.
tags
as a valid property for overrides
.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. You can't
specify tags
as a valid property for overrides
.
overrides
- Describes the component's properties that can be overriden in a customized instance of the component. You
can't specify tags
as a valid property for overrides
.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. You can't
specify tags
as a valid property for overrides
.
overrides
- Describes the component's properties that can be overriden in a customized instance of the component. You
can't specify tags
as a valid property for overrides
.public Component addOverridesEntry(String key, Map<String,String> value)
public Component clearOverridesEntries()
public Map<String,ComponentBindingPropertiesValue> getBindingProperties()
The information to connect a component's properties to data at runtime. You can't specify tags
as a
valid property for bindingProperties
.
tags
as a valid property for bindingProperties
.
public void setBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)
The information to connect a component's properties to data at runtime. You can't specify tags
as a
valid property for bindingProperties
.
bindingProperties
- The information to connect a component's properties to data at runtime. You can't specify
tags
as a valid property for bindingProperties
.
public Component withBindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)
The information to connect a component's properties to data at runtime. You can't specify tags
as a
valid property for bindingProperties
.
bindingProperties
- The information to connect a component's properties to data at runtime. You can't specify
tags
as a valid property for bindingProperties
.
public Component addBindingPropertiesEntry(String key, ComponentBindingPropertiesValue value)
public Component clearBindingPropertiesEntries()
public Map<String,ComponentDataConfiguration> getCollectionProperties()
The data binding configuration for the component's properties. Use this for a collection component. You can't
specify tags
as a valid property for collectionProperties
.
tags
as a valid property for collectionProperties
.public void setCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)
The data binding configuration for the component's properties. Use this for a collection component. You can't
specify tags
as a valid property for collectionProperties
.
collectionProperties
- The data binding configuration for the component's properties. Use this for a collection component. You
can't specify tags
as a valid property for collectionProperties
.public Component withCollectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)
The data binding configuration for the component's properties. Use this for a collection component. You can't
specify tags
as a valid property for collectionProperties
.
collectionProperties
- The data binding configuration for the component's properties. Use this for a collection component. You
can't specify tags
as a valid property for collectionProperties
.public Component addCollectionPropertiesEntry(String key, ComponentDataConfiguration value)
public Component clearCollectionPropertiesEntries()
public void setCreatedAt(Date createdAt)
The time that the component was created.
createdAt
- The time that the component was created.public Date getCreatedAt()
The time that the component was created.
public Component withCreatedAt(Date createdAt)
The time that the component was created.
createdAt
- The time that the component was created.public void setModifiedAt(Date modifiedAt)
The time that the component was modified.
modifiedAt
- The time that the component was modified.public Date getModifiedAt()
The time that the component was modified.
public Component withModifiedAt(Date modifiedAt)
The time that the component was modified.
modifiedAt
- The time that the component was modified.public Map<String,String> getTags()
One or more key-value pairs to use when tagging the component.
public void setTags(Map<String,String> tags)
One or more key-value pairs to use when tagging the component.
tags
- One or more key-value pairs to use when tagging the component.public Component withTags(Map<String,String> tags)
One or more key-value pairs to use when tagging the component.
tags
- One or more key-value pairs to use when tagging the component.public Component clearTagsEntries()
public Map<String,ComponentEvent> getEvents()
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
public void setEvents(Map<String,ComponentEvent> events)
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
events
- Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio
that allows you to bind events and actions to components.public Component withEvents(Map<String,ComponentEvent> events)
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
events
- Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio
that allows you to bind events and actions to components.public Component addEventsEntry(String key, ComponentEvent value)
public Component clearEventsEntries()
public void setSchemaVersion(String schemaVersion)
The schema version of the component when it was imported.
schemaVersion
- The schema version of the component when it was imported.public String getSchemaVersion()
The schema version of the component when it was imported.
public Component withSchemaVersion(String schemaVersion)
The schema version of the component when it was imported.
schemaVersion
- The schema version of the component when it was imported.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.